| 1 |
'\" t |
| 2 |
.TH groff_mm 7 "3 June 2025" "groff 1.23.0" |
| 3 |
.SH Name |
| 4 |
groff_mm \- memorandum macros for GNU |
| 5 |
.I roff |
| 6 |
. |
| 7 |
. |
| 8 |
.\" ==================================================================== |
| 9 |
.\" Legal Terms |
| 10 |
.\" ==================================================================== |
| 11 |
.\" |
| 12 |
.\" Copyright (C) 1989-2023 Free Software Foundation, Inc. |
| 13 |
.\" |
| 14 |
.\" Permission is granted to make and distribute verbatim copies of this |
| 15 |
.\" manual provided the copyright notice and this permission notice are |
| 16 |
.\" preserved on all copies. |
| 17 |
.\" |
| 18 |
.\" Permission is granted to copy and distribute modified versions of |
| 19 |
.\" this manual under the conditions for verbatim copying, provided that |
| 20 |
.\" the entire resulting derived work is distributed under the terms of |
| 21 |
.\" a permission notice identical to this one. |
| 22 |
.\" |
| 23 |
.\" Permission is granted to copy and distribute translations of this |
| 24 |
.\" manual into another language, under the above conditions for |
| 25 |
.\" modified versions, except that this permission notice may be |
| 26 |
.\" included in translations approved by the Free Software Foundation |
| 27 |
.\" instead of in the original English. |
| 28 |
. |
| 29 |
. |
| 30 |
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). |
| 31 |
.do nr *groff_groff_mm_7_man_C \n[.cp] |
| 32 |
.cp 0 |
| 33 |
. |
| 34 |
.\" Define fallback for groff 1.23's MR macro if the system lacks it. |
| 35 |
.nr do-fallback 0 |
| 36 |
.if !\n(.f .nr do-fallback 1 \" mandoc |
| 37 |
.if \n(.g .if !d MR .nr do-fallback 1 \" older groff |
| 38 |
.if !\n(.g .nr do-fallback 1 \" non-groff *roff |
| 39 |
.if \n[do-fallback] \{\ |
| 40 |
. de MR |
| 41 |
. ie \\n(.$=1 \ |
| 42 |
. I \%\\$1 |
| 43 |
. el \ |
| 44 |
. IR \%\\$1 (\\$2)\\$3 |
| 45 |
. . |
| 46 |
.\} |
| 47 |
.rr do-fallback |
| 48 |
. |
| 49 |
. |
| 50 |
.\" ==================================================================== |
| 51 |
.SH Synopsis |
| 52 |
.\" ==================================================================== |
| 53 |
. |
| 54 |
.SY "groff \-m\%m" |
| 55 |
.RI [ option\~ .\|.\|.\&] |
| 56 |
.RI [ file\~ .\|.\|.] |
| 57 |
. |
| 58 |
.SY "groff \-m m\%m" |
| 59 |
.RI [ option\~ .\|.\|.\&] |
| 60 |
.RI [ file\~ .\|.\|.] |
| 61 |
.YS |
| 62 |
. |
| 63 |
. |
| 64 |
.\" ==================================================================== |
| 65 |
.SH Description |
| 66 |
.\" ==================================================================== |
| 67 |
. |
| 68 |
The GNU implementation of the |
| 69 |
.I mm |
| 70 |
macro package is part of the |
| 71 |
.I groff |
| 72 |
document formatting system. |
| 73 |
. |
| 74 |
The |
| 75 |
.I mm |
| 76 |
package is suitable for the composition of |
| 77 |
letters, |
| 78 |
memoranda, |
| 79 |
reports, |
| 80 |
and books. |
| 81 |
. |
| 82 |
. |
| 83 |
.P |
| 84 |
Call an |
| 85 |
.I mm |
| 86 |
macro at the beginning of a document to initialize the package. |
| 87 |
. |
| 88 |
A simple |
| 89 |
.I mm |
| 90 |
document might use only |
| 91 |
.B P |
| 92 |
for paragraphing. |
| 93 |
. |
| 94 |
Set numbered and unnumbered section headings with |
| 95 |
.B H |
| 96 |
and |
| 97 |
.BR HU , |
| 98 |
respectively. |
| 99 |
. |
| 100 |
Change the style of the typeface with |
| 101 |
.BR B , |
| 102 |
.BR I , |
| 103 |
and |
| 104 |
.BR R ; |
| 105 |
you can alternate styles with |
| 106 |
.BR BI , |
| 107 |
.BR BR , |
| 108 |
.BR IB , |
| 109 |
.BR IR , |
| 110 |
.BR RB , |
| 111 |
and |
| 112 |
.BR RI . |
| 113 |
. |
| 114 |
Several nestable list types are available via |
| 115 |
.BR AL , |
| 116 |
.BR BL , |
| 117 |
.BR BVL , |
| 118 |
.BR DL , |
| 119 |
.BR ML , |
| 120 |
.BR RL , |
| 121 |
and |
| 122 |
.BR VL ; |
| 123 |
each of these begins a list, |
| 124 |
to which |
| 125 |
.B LI |
| 126 |
adds an item and |
| 127 |
.B LE |
| 128 |
ends the (nested) list. |
| 129 |
. |
| 130 |
Customized list arrangements are supported by |
| 131 |
.BR LB . |
| 132 |
. |
| 133 |
.B DS |
| 134 |
and |
| 135 |
.B DF |
| 136 |
start static and floating displays, |
| 137 |
respectively; |
| 138 |
either is terminated with |
| 139 |
.BR DE . |
| 140 |
. |
| 141 |
. |
| 142 |
.P |
| 143 |
.I groff mm |
| 144 |
is intended to be compatible with the |
| 145 |
.I mm |
| 146 |
implementation found in the AT&T Documenter's Workbench (DWB), |
| 147 |
with the following limitations. |
| 148 |
. |
| 149 |
. |
| 150 |
.IP \[bu] 2n |
| 151 |
Omitted features include |
| 152 |
the logo and company name strings, |
| 153 |
.B }Z |
| 154 |
and |
| 155 |
.BR ]S , |
| 156 |
respectively; |
| 157 |
the encoded company site location addresses recognized as the third |
| 158 |
argument to the |
| 159 |
.B AU |
| 160 |
macro; |
| 161 |
the |
| 162 |
.B Pv |
| 163 |
(\[lq]private\[rq] heading) |
| 164 |
register; |
| 165 |
and the |
| 166 |
.B OK |
| 167 |
(other keywords), |
| 168 |
and |
| 169 |
.B PM |
| 170 |
(proprietary markings) |
| 171 |
macros. |
| 172 |
. |
| 173 |
. |
| 174 |
.IP \[bu] 2n |
| 175 |
The |
| 176 |
.B CS |
| 177 |
(output cover sheet) |
| 178 |
macro is implemented only for memorandum type 4. |
| 179 |
. |
| 180 |
. |
| 181 |
.IP \[bu] |
| 182 |
The |
| 183 |
.I grap |
| 184 |
preprocessor is not explicitly supported; |
| 185 |
no |
| 186 |
.B G1 |
| 187 |
and |
| 188 |
.B G2 |
| 189 |
macros |
| 190 |
are defined. |
| 191 |
. |
| 192 |
. |
| 193 |
.IP \[bu] |
| 194 |
The registers |
| 195 |
.BR A , |
| 196 |
.BR C , |
| 197 |
.BR E , |
| 198 |
.BR T , |
| 199 |
and |
| 200 |
.BR U , |
| 201 |
typically set from the |
| 202 |
.I troff \" generic |
| 203 |
or |
| 204 |
.I nroff \" generic |
| 205 |
command lines with DWB |
| 206 |
.IR mm , |
| 207 |
are not recognized. |
| 208 |
. |
| 209 |
. |
| 210 |
.IP \[bu] |
| 211 |
When setting the registers |
| 212 |
.B L |
| 213 |
or |
| 214 |
.B W |
| 215 |
from the command line, |
| 216 |
use an explicit scaling unit to avoid surprises. |
| 217 |
. |
| 218 |
. |
| 219 |
.IP \[bu] |
| 220 |
DWB |
| 221 |
.IR mm 's |
| 222 |
.B nP |
| 223 |
macro indented the second line of a paragraph to align it with the start |
| 224 |
of the text of the first |
| 225 |
(after the paragraph number); |
| 226 |
.IR "groff mm" 's |
| 227 |
does not. |
| 228 |
. |
| 229 |
. |
| 230 |
.IP \[bu] |
| 231 |
Cut marks are not supported. |
| 232 |
. |
| 233 |
. |
| 234 |
.P |
| 235 |
DWB |
| 236 |
.I mm |
| 237 |
supported only seven levels of heading. |
| 238 |
. |
| 239 |
As a compatible extension, |
| 240 |
.I groff mm |
| 241 |
supports fourteen, |
| 242 |
introducing new registers |
| 243 |
.B H8 |
| 244 |
through |
| 245 |
.BR H14 , |
| 246 |
and affecting the interpretation of the |
| 247 |
.B HF |
| 248 |
and |
| 249 |
.B HP |
| 250 |
strings. |
| 251 |
. |
| 252 |
. |
| 253 |
.P |
| 254 |
Macro, |
| 255 |
register, |
| 256 |
and string descriptions in this page frequently mention each other; |
| 257 |
most cross references are to macros. |
| 258 |
. |
| 259 |
Where a register or string is referenced, |
| 260 |
its type is explicitly identified. |
| 261 |
. |
| 262 |
.IR mm 's |
| 263 |
macro names are usually in full capitals; |
| 264 |
registers and strings tend to have mixed-case names. |
| 265 |
. |
| 266 |
. |
| 267 |
.\" ==================================================================== |
| 268 |
.SS "Document styles" |
| 269 |
.\" ==================================================================== |
| 270 |
. |
| 271 |
.I groff mm |
| 272 |
offers three different frameworks for document organization. |
| 273 |
. |
| 274 |
.BR \%COVER /\: \%COVEND |
| 275 |
is a flexible means of preparing any document requiring a cover page. |
| 276 |
. |
| 277 |
.BR LT / LO |
| 278 |
aids preparation of typical Anglophone correspondence |
| 279 |
(business letters, |
| 280 |
for example). |
| 281 |
. |
| 282 |
The |
| 283 |
.B MT |
| 284 |
memorandum type mechanism implements a group of formal styles |
| 285 |
historically used by AT&T Bell Laboratories. |
| 286 |
. |
| 287 |
Your document can select at most one of these approaches; |
| 288 |
when used, |
| 289 |
each disables the others. |
| 290 |
. |
| 291 |
. |
| 292 |
.\" ==================================================================== |
| 293 |
.SS Localization |
| 294 |
.\" ==================================================================== |
| 295 |
. |
| 296 |
.I groff mm |
| 297 |
is designed to be easily localized. |
| 298 |
. |
| 299 |
For languages other than English, |
| 300 |
strings that can appear in output are collected in the file |
| 301 |
.IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\: xx \:.tmac , |
| 302 |
where |
| 303 |
.I xx |
| 304 |
is an ISO\~639 two-letter language identifier. |
| 305 |
. |
| 306 |
Localization packages should be loaded after |
| 307 |
.IR mm ; |
| 308 |
for example, |
| 309 |
you might format a Swedish |
| 310 |
.I mm |
| 311 |
document with the command |
| 312 |
.RB \[lq] "groff \-mm \-msv" \[rq]. |
| 313 |
. |
| 314 |
. |
| 315 |
.P |
| 316 |
This package can also be localized by site or territory; |
| 317 |
for example, |
| 318 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:\%mse\:.tmac |
| 319 |
illustrates how to adapt the output to a national standard using its ISO |
| 320 |
3166 territory code. |
| 321 |
. |
| 322 |
Such a package can define a string that causes a macro file |
| 323 |
.IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:mm/\:\% territory _locale |
| 324 |
to be loaded at package initialization. |
| 325 |
. |
| 326 |
If this mechanism is not used, |
| 327 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:mm/\:\%locale |
| 328 |
is loaded instead. |
| 329 |
. |
| 330 |
No diagnostic is produced if these files do not exist. |
| 331 |
. |
| 332 |
. |
| 333 |
.\" ==================================================================== |
| 334 |
.SS "Registers and strings" |
| 335 |
.\" ==================================================================== |
| 336 |
. |
| 337 |
Much |
| 338 |
.I mm |
| 339 |
behavior can be configured by registers and strings. |
| 340 |
. |
| 341 |
A register is assigned with the |
| 342 |
.B nr |
| 343 |
request. |
| 344 |
. |
| 345 |
. |
| 346 |
.RS |
| 347 |
.P |
| 348 |
.B .nr |
| 349 |
.I ident |
| 350 |
.RB [ \[+-] ]\c |
| 351 |
.I n |
| 352 |
.RI [ i ] |
| 353 |
.RE |
| 354 |
. |
| 355 |
. |
| 356 |
.P |
| 357 |
.I ident |
| 358 |
is the name of the register, |
| 359 |
and |
| 360 |
.IR n \~is |
| 361 |
the value to be assigned. |
| 362 |
. |
| 363 |
.IR n \~can |
| 364 |
be prefixed with a plus or minus sign if incrementation or |
| 365 |
decrementation (respectively) of the register's existing value |
| 366 |
.RI by\~ n |
| 367 |
is desired. |
| 368 |
. |
| 369 |
If assignment of a (possibly) negative |
| 370 |
.IR n \~is |
| 371 |
required, |
| 372 |
further prefix it with a zero or enclose it in parentheses. |
| 373 |
. |
| 374 |
If |
| 375 |
.IR i \~is |
| 376 |
specified, |
| 377 |
the register is automatically modified |
| 378 |
.RI by \~i |
| 379 |
prior to interpolation if a plus or minus sign is included in the escape |
| 380 |
sequence as follows. |
| 381 |
. |
| 382 |
. |
| 383 |
.RS |
| 384 |
.P |
| 385 |
.B \[rs]n\c |
| 386 |
.RB [ \[+-] ]\c |
| 387 |
.BI [ ident ] |
| 388 |
.RE |
| 389 |
. |
| 390 |
. |
| 391 |
.P |
| 392 |
.IR i \~can |
| 393 |
be negative; |
| 394 |
it combines algebraically with the sign in the interpolation escape |
| 395 |
sequence. |
| 396 |
. |
| 397 |
. |
| 398 |
.P |
| 399 |
Strings are defined with the |
| 400 |
.B ds |
| 401 |
request. |
| 402 |
. |
| 403 |
. |
| 404 |
.RS |
| 405 |
.P |
| 406 |
.B .ds |
| 407 |
.I ident contents |
| 408 |
.RE |
| 409 |
. |
| 410 |
. |
| 411 |
.P |
| 412 |
.I contents |
| 413 |
consumes everything up to the end of the line, |
| 414 |
including trailing spaces. |
| 415 |
. |
| 416 |
It is a good practice to end |
| 417 |
.I contents |
| 418 |
with a comment escape sequence |
| 419 |
.RB ( \[rs]\[dq] ) |
| 420 |
so that extraneous spaces do not intrude during document maintenance. |
| 421 |
. |
| 422 |
To include leading spaces in |
| 423 |
.IR contents , |
| 424 |
prefix it with a double quote. |
| 425 |
. |
| 426 |
Strings are interpolated with the |
| 427 |
.B \[rs]* |
| 428 |
escape sequence. |
| 429 |
. |
| 430 |
. |
| 431 |
.RS |
| 432 |
.P |
| 433 |
.B \[rs]*\c |
| 434 |
.BI [ ident ] |
| 435 |
.RE |
| 436 |
. |
| 437 |
. |
| 438 |
.P |
| 439 |
Register and string name spaces are distinct, |
| 440 |
but strings and macros share a name space. |
| 441 |
. |
| 442 |
Defining a string with the same name as an |
| 443 |
.I mm |
| 444 |
macro is not supported and may cause incorrect rendering, |
| 445 |
the emission of diagnostic messages, |
| 446 |
and an error exit status from |
| 447 |
.IR \%troff . |
| 448 |
. |
| 449 |
. |
| 450 |
.\" ==================================================================== |
| 451 |
.SS "Register format" |
| 452 |
.\" ==================================================================== |
| 453 |
. |
| 454 |
A register is interpolated using Arabic numerals if no other format has |
| 455 |
been assigned to it. |
| 456 |
. |
| 457 |
Assign a format to a register with the |
| 458 |
.B af |
| 459 |
request. |
| 460 |
. |
| 461 |
. |
| 462 |
.RS |
| 463 |
.LP |
| 464 |
.BI .af\~ "R c" |
| 465 |
.RE |
| 466 |
. |
| 467 |
. |
| 468 |
.LP |
| 469 |
.IR R \~is |
| 470 |
the name of the register, |
| 471 |
and |
| 472 |
.IR c \~is |
| 473 |
the format. |
| 474 |
. |
| 475 |
If |
| 476 |
.IR c \~is |
| 477 |
a sequence of Arabic numerals, |
| 478 |
their quantity defines a zero-padded minimum width for the interpolated |
| 479 |
register value. |
| 480 |
. |
| 481 |
. |
| 482 |
.RS |
| 483 |
.LP |
| 484 |
.TS |
| 485 |
tab(@); |
| 486 |
lb lb |
| 487 |
l l. |
| 488 |
Form@Sequence |
| 489 |
1@0, 1, 2, 3, .\|.\|., 10, .\|.\|. |
| 490 |
001@000, 001, 002, 003, .\|.\|., 1000, .\|.\|. |
| 491 |
i@0, i, ii, iii, iv, .\|.\|. |
| 492 |
I@0, I, II, III, IV, .\|.\|. |
| 493 |
a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|. |
| 494 |
A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|. |
| 495 |
.TE |
| 496 |
.RE |
| 497 |
. |
| 498 |
. |
| 499 |
.\" ==================================================================== |
| 500 |
.SS Fonts |
| 501 |
.\" ==================================================================== |
| 502 |
. |
| 503 |
In |
| 504 |
.IR "groff mm" , |
| 505 |
the fonts |
| 506 |
(or rather, |
| 507 |
font styles) |
| 508 |
.BR R \~(roman), |
| 509 |
.BR I \~(italic), |
| 510 |
and |
| 511 |
.BR B \~(bold) |
| 512 |
are mounted at font positions |
| 513 |
.BR 1 , |
| 514 |
.BR 2 , |
| 515 |
.RB and\~ 3 , |
| 516 |
respectively. |
| 517 |
. |
| 518 |
Internally, |
| 519 |
font positions are used for backward compatibility. |
| 520 |
. |
| 521 |
From a practical point of view, |
| 522 |
it doesn't make a big difference\[em]a different font family can still |
| 523 |
be selected by invoking |
| 524 |
.IR groff 's |
| 525 |
.B fam |
| 526 |
request or using its |
| 527 |
.B \-f |
| 528 |
command-line option. |
| 529 |
. |
| 530 |
On the other hand, |
| 531 |
if you want to replace just, |
| 532 |
for example, |
| 533 |
.RB font\~ I |
| 534 |
with Zapf Chancery Medium italic |
| 535 |
(available on |
| 536 |
.IR groff 's |
| 537 |
.B pdf |
| 538 |
and |
| 539 |
.B ps |
| 540 |
output devices), |
| 541 |
you have to use the |
| 542 |
.B fp |
| 543 |
request, |
| 544 |
replacing the font at position\~2 with |
| 545 |
.RB \[lq] .fp\~2\~ZCMI \[rq]). |
| 546 |
. |
| 547 |
Because the cover sheet, |
| 548 |
memorandum type, |
| 549 |
and |
| 550 |
.MR \%refer 1 |
| 551 |
integration macros explicitly request fonts named |
| 552 |
.BR B , |
| 553 |
.BR I , |
| 554 |
and |
| 555 |
.BR R , |
| 556 |
you will also need to remap these font names with the |
| 557 |
.B ftr |
| 558 |
request, |
| 559 |
for instance with |
| 560 |
.RB \[lq] .ftr\~I\~ZCMI \[rq]. |
| 561 |
. |
| 562 |
. |
| 563 |
.\" ==================================================================== |
| 564 |
.SH Macros |
| 565 |
.\" ==================================================================== |
| 566 |
. |
| 567 |
An explicitly empty argument may be specified with a pair of double |
| 568 |
quotes; |
| 569 |
to call a macro |
| 570 |
.B XX |
| 571 |
with an empty second argument but non-empty first and third ones, |
| 572 |
you could input the following. |
| 573 |
. |
| 574 |
. |
| 575 |
.P |
| 576 |
.RS |
| 577 |
.EX |
| 578 |
\&.XX foo \[dq]\[dq] baz |
| 579 |
.EE |
| 580 |
.RE |
| 581 |
. |
| 582 |
. |
| 583 |
.P |
| 584 |
Macro names longer than two characters are GNU extensions; |
| 585 |
some shorter names were not part of DWB |
| 586 |
.IR mm 's |
| 587 |
published interface but are documented aspects of |
| 588 |
.I groff mm. |
| 589 |
. |
| 590 |
. |
| 591 |
.TP |
| 592 |
.BI )E\ "level text" |
| 593 |
Add heading text |
| 594 |
.I text |
| 595 |
to the table of contents with |
| 596 |
.IR level , |
| 597 |
which is either\~0 or in the range 1 to\~7. |
| 598 |
. |
| 599 |
See also |
| 600 |
.BR H . |
| 601 |
. |
| 602 |
This undocumented DWB |
| 603 |
.I mm |
| 604 |
macro is exposed by |
| 605 |
.I groff mm |
| 606 |
to enable customized tables of contents. |
| 607 |
. |
| 608 |
. |
| 609 |
.TP |
| 610 |
.BR 1C\~ [ 1 ] |
| 611 |
Format page text in one column. |
| 612 |
. |
| 613 |
The page is broken. |
| 614 |
. |
| 615 |
.RB A\~ 1 |
| 616 |
argument suppresses this break; |
| 617 |
its use may cause body text and a pending footnote to overprint. |
| 618 |
. |
| 619 |
See |
| 620 |
.BR 2C , |
| 621 |
.BR MC , |
| 622 |
and |
| 623 |
.BR NCOL . |
| 624 |
. |
| 625 |
. |
| 626 |
.TP |
| 627 |
.B 2C |
| 628 |
Begin two-column formatting. |
| 629 |
. |
| 630 |
This is a special case of |
| 631 |
.BR MC . |
| 632 |
. |
| 633 |
See |
| 634 |
.B 1C |
| 635 |
and |
| 636 |
.BR NCOL . |
| 637 |
. |
| 638 |
. |
| 639 |
.TP |
| 640 |
.B AE |
| 641 |
Abstract end; |
| 642 |
stop collecting abstract text. |
| 643 |
. |
| 644 |
See |
| 645 |
.BR AS . |
| 646 |
. |
| 647 |
. |
| 648 |
.\" In DWB mm, the mnemonic for `AF` was "alternate first-page format", |
| 649 |
.\" and was described in the context of the `A` and `E` registers and |
| 650 |
.\" `}Z` and `]S` strings, none of which we support. |
| 651 |
.TP |
| 652 |
.BR AF \~[\c |
| 653 |
.IR firm-name ] |
| 654 |
Specify firm associated with the document. |
| 655 |
. |
| 656 |
At most one can be declared; |
| 657 |
the firm name is used by memorandum types and available to cover sheets. |
| 658 |
. |
| 659 |
.B AF |
| 660 |
terminates a document title started with |
| 661 |
.BR TL , |
| 662 |
and can be called without an argument for that purpose. |
| 663 |
. |
| 664 |
See |
| 665 |
.B MT |
| 666 |
and |
| 667 |
.BR COVER . |
| 668 |
. |
| 669 |
. |
| 670 |
.TP |
| 671 |
.BR AL \~[\c |
| 672 |
.IR type \~[ text-indent \~[\c |
| 673 |
.BR 1 ]]] |
| 674 |
Begin an auto-incrementing numbered list. |
| 675 |
. |
| 676 |
Item numbers start at one. |
| 677 |
. |
| 678 |
The |
| 679 |
.I type |
| 680 |
argument assigns the register format |
| 681 |
(see above) |
| 682 |
of the list item enumerators. |
| 683 |
. |
| 684 |
The default |
| 685 |
.RB is\~ 1 . |
| 686 |
. |
| 687 |
An explicitly empty |
| 688 |
.I type |
| 689 |
also indicates the default. |
| 690 |
. |
| 691 |
A |
| 692 |
.I text-indent |
| 693 |
argument overrides register |
| 694 |
.BR Li . |
| 695 |
. |
| 696 |
A third argument suppresses the blank line that normally precedes each |
| 697 |
list item. |
| 698 |
. |
| 699 |
Use |
| 700 |
.B LI |
| 701 |
to declare list items, |
| 702 |
and |
| 703 |
.B LE |
| 704 |
to end the list. |
| 705 |
. |
| 706 |
. |
| 707 |
.TP |
| 708 |
.BR APP \~\c |
| 709 |
.RI [ id\~ [ title ]] |
| 710 |
Begin an appendix. |
| 711 |
. |
| 712 |
If the identifier |
| 713 |
.I id |
| 714 |
is omitted, |
| 715 |
it is incremented |
| 716 |
(or initialized, |
| 717 |
if necessary). |
| 718 |
. |
| 719 |
The register format used for |
| 720 |
.I id |
| 721 |
is \[lq]A\[rq]. |
| 722 |
. |
| 723 |
The page is broken. |
| 724 |
. |
| 725 |
The register |
| 726 |
.B Aph |
| 727 |
determines whether an appendix heading is then formatted. |
| 728 |
. |
| 729 |
This heading uses the string |
| 730 |
.B App |
| 731 |
followed by |
| 732 |
.IR id . |
| 733 |
. |
| 734 |
Appendices appear in any table of contents |
| 735 |
(see |
| 736 |
.BR TC ). |
| 737 |
. |
| 738 |
The string |
| 739 |
.B Apptxt |
| 740 |
is set to |
| 741 |
.I title |
| 742 |
if the latter is present, |
| 743 |
and made empty otherwise. |
| 744 |
. |
| 745 |
. |
| 746 |
.TP |
| 747 |
.BI APPSK\~ "id n" \~\c |
| 748 |
.RI [ title ] |
| 749 |
As |
| 750 |
.BR APP , |
| 751 |
but increment the page number by |
| 752 |
.IR n . |
| 753 |
. |
| 754 |
Use this macro to \[lq]skip pages\[rq] when diagrams or other materials |
| 755 |
not formatted by |
| 756 |
.I \%troff |
| 757 |
are included in appendices. |
| 758 |
. |
| 759 |
. |
| 760 |
.TP |
| 761 |
.BR AS\~ [\c |
| 762 |
.IR placement \~[ indentation ]] |
| 763 |
Abstract start; |
| 764 |
begin collecting abstract. |
| 765 |
. |
| 766 |
Input up to the next |
| 767 |
.B AE |
| 768 |
call is included in the abstract. |
| 769 |
. |
| 770 |
.I placement |
| 771 |
influences the location of the abstract on the cover sheet of a |
| 772 |
memorandum |
| 773 |
(see |
| 774 |
.BR MT ). |
| 775 |
. |
| 776 |
.BR \%COVER , |
| 777 |
by contrast, |
| 778 |
ignores |
| 779 |
.I placement |
| 780 |
by default, |
| 781 |
but can be customized to interpret it. |
| 782 |
. |
| 783 |
. |
| 784 |
.IP |
| 785 |
.TS |
| 786 |
tab(@); |
| 787 |
lf(BI) lb |
| 788 |
l lx. |
| 789 |
placement@Effect |
| 790 |
0@T{ |
| 791 |
The abstract appears on page\~1 and cover sheet if the document is a |
| 792 |
\[lq]released paper\[rq] memorandum |
| 793 |
.RB (\[lq] ".MT 4" \[rq]); |
| 794 |
otherwise, |
| 795 |
it appears on page\~1 without a cover sheet. |
| 796 |
T} |
| 797 |
1@T{ |
| 798 |
The abstract appears only on the cover sheet |
| 799 |
.RB (\[lq] ".MT 4" \[rq] |
| 800 |
only). |
| 801 |
T} |
| 802 |
.\" XXX: This does not appear to be implemented. |
| 803 |
.\"2@T{ |
| 804 |
.\"The abstract is printed only on the cover sheet (if not |
| 805 |
.\".BR ".MT 4" ) |
| 806 |
.\". |
| 807 |
.\"The cover sheet is printed without a need for \fBCS\fP. |
| 808 |
.\"T} |
| 809 |
.TE |
| 810 |
. |
| 811 |
. |
| 812 |
.IP |
| 813 |
An abstract does not appear at all in external letters |
| 814 |
.RB (\[lq] ".MT 5" \[rq]). |
| 815 |
. |
| 816 |
.RI A\~ placement |
| 817 |
of |
| 818 |
.B 2 |
| 819 |
was supported by DWB |
| 820 |
.I mm |
| 821 |
but is not by |
| 822 |
.IR "groff mm" . |
| 823 |
. |
| 824 |
. |
| 825 |
.IP |
| 826 |
A second argument increases the indentation by |
| 827 |
.I indentation |
| 828 |
and reduces the line length by twice this amount. |
| 829 |
. |
| 830 |
A scaling unit of ens is assumed. |
| 831 |
. |
| 832 |
The default is\~0. |
| 833 |
. |
| 834 |
. |
| 835 |
.\" XXX: Do we need a macro for this? Why is it not a string like App |
| 836 |
.\" or Licon? It is usefully localizable. |
| 837 |
.TP |
| 838 |
.BR AST \~\c |
| 839 |
.RI [ caption ] |
| 840 |
Set the caption above the abstract to |
| 841 |
.IR caption , |
| 842 |
or clear it if there is no argument. |
| 843 |
. |
| 844 |
The default is \[lq]ABSTRACT\[rq]. |
| 845 |
. |
| 846 |
. |
| 847 |
.TP |
| 848 |
.BI AT\~ title\c |
| 849 |
\~.\|.\|. |
| 850 |
Specify author's title(s). |
| 851 |
. |
| 852 |
If present, |
| 853 |
.B AT |
| 854 |
must appear just after the corresponding author's |
| 855 |
.BR AU . |
| 856 |
. |
| 857 |
Each |
| 858 |
.I title |
| 859 |
occupies an output line beneath the author's name in the signature block |
| 860 |
used by |
| 861 |
.B LT |
| 862 |
letters |
| 863 |
(see |
| 864 |
.BR SG ) |
| 865 |
and in |
| 866 |
.B MT |
| 867 |
memoranda. |
| 868 |
. |
| 869 |
The |
| 870 |
.B ms |
| 871 |
cover sheet style also uses it. |
| 872 |
. |
| 873 |
. |
| 874 |
.br |
| 875 |
.ne 7v |
| 876 |
.TP |
| 877 |
.BR AU \~\c |
| 878 |
.RI [ name\~\c |
| 879 |
.RI [ initials\~\c |
| 880 |
.RI [ loc\~\c |
| 881 |
.RI [ dept\~\c |
| 882 |
.RI [ ext\~\c |
| 883 |
.RI [ room\~\c |
| 884 |
.RI [ arg1\~\c |
| 885 |
.RI [ arg2\~\c |
| 886 |
.RI [ arg3 ]]]]]]]]] |
| 887 |
Specify author. |
| 888 |
. |
| 889 |
.B AU |
| 890 |
terminates a document title started with |
| 891 |
.BR TL , |
| 892 |
and can be called without arguments for that purpose. |
| 893 |
. |
| 894 |
Author information is used by cover sheets, |
| 895 |
.B MT |
| 896 |
memoranda, |
| 897 |
and |
| 898 |
.BR SG . |
| 899 |
. |
| 900 |
Further arguments comprise |
| 901 |
initials, |
| 902 |
location, |
| 903 |
department, |
| 904 |
telephone extension, |
| 905 |
room number or name, |
| 906 |
and up to three additional items. |
| 907 |
. |
| 908 |
Repeat |
| 909 |
.B AU |
| 910 |
to identify multiple authors. |
| 911 |
. |
| 912 |
. |
| 913 |
.IP |
| 914 |
Use |
| 915 |
.BR WA / WE |
| 916 |
instead to identify the author for documents employing |
| 917 |
.BR LT . |
| 918 |
. |
| 919 |
. |
| 920 |
.TP |
| 921 |
.BR AV \~[\c |
| 922 |
.IR name \~[\c |
| 923 |
.BR 1 ]] |
| 924 |
Format approval lines for a handwritten signature and date. |
| 925 |
. |
| 926 |
Two horizontal rules are drawn, |
| 927 |
with the specified |
| 928 |
.I name |
| 929 |
and the text of the string |
| 930 |
.B Letdate |
| 931 |
beneath them. |
| 932 |
. |
| 933 |
Above these rules, |
| 934 |
the text in the string |
| 935 |
.B Letapp |
| 936 |
is formatted; |
| 937 |
a second argument replaces this text with a blank line. |
| 938 |
. |
| 939 |
See |
| 940 |
.BR LT . |
| 941 |
. |
| 942 |
. |
| 943 |
.\" XXX: AVL is misnamed; it should have been called SGL or similar. |
| 944 |
.TP |
| 945 |
.BR AVL \~[\c |
| 946 |
.IR name ] |
| 947 |
As |
| 948 |
.BR AV , |
| 949 |
but the date, |
| 950 |
date rule, |
| 951 |
and approval notation |
| 952 |
.B Letapp |
| 953 |
are omitted. |
| 954 |
. |
| 955 |
. |
| 956 |
.TP |
| 957 |
.BR B \~\c \" space in roman; we must use 2-font macro with \c |
| 958 |
.RI [ bold-text\~\c |
| 959 |
.RI [ previous-font-text ]]\~.\|.\|. |
| 960 |
Join |
| 961 |
.I bold-text |
| 962 |
in boldface with |
| 963 |
.I previous-font-text |
| 964 |
in the previous font, |
| 965 |
without space between the arguments. |
| 966 |
. |
| 967 |
If no arguments, |
| 968 |
switch font to bold style. |
| 969 |
. |
| 970 |
. |
| 971 |
.TP |
| 972 |
.B B1 |
| 973 |
Begin boxed, |
| 974 |
kept display. |
| 975 |
. |
| 976 |
The text is indented one character, |
| 977 |
and the right margin is one character shorter. |
| 978 |
. |
| 979 |
This is a GNU extension. |
| 980 |
. |
| 981 |
. |
| 982 |
.TP |
| 983 |
.B B2 |
| 984 |
End boxed, |
| 985 |
kept display. |
| 986 |
. |
| 987 |
This is a GNU extension. |
| 988 |
. |
| 989 |
. |
| 990 |
.TP |
| 991 |
.B BE |
| 992 |
End bottom block; see |
| 993 |
.BR BS . |
| 994 |
. |
| 995 |
. |
| 996 |
.TP |
| 997 |
.BR BI \~\c \" space in roman; we must use 2-font macro with \c |
| 998 |
.RI [ bold-text\~\c |
| 999 |
.RI [ italic-text ]]\~.\|.\|. |
| 1000 |
Join |
| 1001 |
.I bold-text |
| 1002 |
in boldface with |
| 1003 |
.I italic-text |
| 1004 |
in italics, |
| 1005 |
without space between the arguments. |
| 1006 |
. |
| 1007 |
. |
| 1008 |
.TP |
| 1009 |
.BR BL \~[\c |
| 1010 |
.IR text-indent \~[\c |
| 1011 |
.BR 1 ]] |
| 1012 |
Begin bulleted list. |
| 1013 |
. |
| 1014 |
Items are prefixed with a bullet and a space. |
| 1015 |
. |
| 1016 |
A |
| 1017 |
.I text-indent |
| 1018 |
argument overrides register |
| 1019 |
.BR Pi . |
| 1020 |
. |
| 1021 |
A second argument suppresses blank lines between items. |
| 1022 |
. |
| 1023 |
Use |
| 1024 |
.B LI |
| 1025 |
to declare list items, |
| 1026 |
and |
| 1027 |
.B LE |
| 1028 |
to end the list. |
| 1029 |
. |
| 1030 |
. |
| 1031 |
.TP |
| 1032 |
.BR BR \~\c \" space in roman; we must use 2-font macro with \c |
| 1033 |
.RI [ bold-text\~\c |
| 1034 |
.RI [ roman-text ]]\~.\|.\|. |
| 1035 |
Join |
| 1036 |
.I bold-text |
| 1037 |
in boldface with |
| 1038 |
.I roman-text |
| 1039 |
in roman style, |
| 1040 |
without space between the arguments. |
| 1041 |
. |
| 1042 |
. |
| 1043 |
.TP |
| 1044 |
.B BS |
| 1045 |
Begin bottom block. |
| 1046 |
. |
| 1047 |
Input is collected until |
| 1048 |
.B BE |
| 1049 |
is called, |
| 1050 |
and output between the footnote area and footer of each page. |
| 1051 |
. |
| 1052 |
. |
| 1053 |
.\" XXX: Couldn't this have been done with an extra parameter to `VL`? |
| 1054 |
.\" Or a register influencing VL behavior? |
| 1055 |
.TP |
| 1056 |
.BR BVL \~[\c |
| 1057 |
.IR text-indent \~[ mark-indent \~[\c |
| 1058 |
.BR 1 ]]] |
| 1059 |
Begin broken variable-item |
| 1060 |
(or \[lq]tagged\[rq]) |
| 1061 |
list. |
| 1062 |
. |
| 1063 |
Each item is expected to supply its own mark. |
| 1064 |
. |
| 1065 |
The line is always broken after the mark; |
| 1066 |
contrast |
| 1067 |
.BR VL . |
| 1068 |
. |
| 1069 |
.I text-indent |
| 1070 |
sets the indentation of the text, |
| 1071 |
and |
| 1072 |
.I mark-indent |
| 1073 |
the distance from the current list indentation to the mark. |
| 1074 |
. |
| 1075 |
A third argument suppresses the blank line that normally precedes each |
| 1076 |
list item. |
| 1077 |
. |
| 1078 |
Use |
| 1079 |
.B LI |
| 1080 |
to declare list items, |
| 1081 |
and |
| 1082 |
.B LE |
| 1083 |
to end the list. |
| 1084 |
. |
| 1085 |
. |
| 1086 |
.TP |
| 1087 |
.BR \%COVER \~\c \" space in roman; we must use 2-font macro with \c |
| 1088 |
.RI [ style ] |
| 1089 |
Begin a cover page description. |
| 1090 |
. |
| 1091 |
.B \%COVER |
| 1092 |
must appear before the body text |
| 1093 |
(or main matter) |
| 1094 |
of a document. |
| 1095 |
. |
| 1096 |
The argument |
| 1097 |
.I style |
| 1098 |
is used to construct the file name |
| 1099 |
.IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/\: style \:.cov |
| 1100 |
and load it with the |
| 1101 |
.B mso |
| 1102 |
request. |
| 1103 |
. |
| 1104 |
The default |
| 1105 |
.I style |
| 1106 |
is |
| 1107 |
.BR ms ; |
| 1108 |
the |
| 1109 |
.I ms.cov |
| 1110 |
file prepares a cover page resembling those of the |
| 1111 |
.I ms |
| 1112 |
package. |
| 1113 |
. |
| 1114 |
A |
| 1115 |
.I .cov |
| 1116 |
file must define a |
| 1117 |
.B \%COVEND |
| 1118 |
macro, |
| 1119 |
which a document must call at the end of the cover description. |
| 1120 |
. |
| 1121 |
Use cover description macros in the following order; |
| 1122 |
only |
| 1123 |
.B TL |
| 1124 |
and |
| 1125 |
.B AU |
| 1126 |
are required. |
| 1127 |
. |
| 1128 |
. |
| 1129 |
.IP |
| 1130 |
.EX |
| 1131 |
\&.COVER |
| 1132 |
\&.TL |
| 1133 |
\&.AF |
| 1134 |
\&.AU |
| 1135 |
\&.AT |
| 1136 |
\&.AS |
| 1137 |
.ne 2v |
| 1138 |
\&.AE |
| 1139 |
\&.COVEND |
| 1140 |
.EE |
| 1141 |
. |
| 1142 |
. |
| 1143 |
.TP |
| 1144 |
.B COVEND |
| 1145 |
End the cover description. |
| 1146 |
. |
| 1147 |
. |
| 1148 |
.TP |
| 1149 |
.B DE |
| 1150 |
End static or floating display begun with |
| 1151 |
.B DS |
| 1152 |
or |
| 1153 |
.BR DF . |
| 1154 |
. |
| 1155 |
. |
| 1156 |
.TP |
| 1157 |
.BR DF\~ [\c |
| 1158 |
.IR format \~[ fill \~[ right-indentation ]]] |
| 1159 |
Begin floating display. |
| 1160 |
. |
| 1161 |
A floating display is saved in a queue and output in the order entered. |
| 1162 |
. |
| 1163 |
Arguments are handled as in |
| 1164 |
.BR DS . |
| 1165 |
. |
| 1166 |
Floating displays cannot be nested. |
| 1167 |
. |
| 1168 |
Placement of floating displays is controlled by the registers |
| 1169 |
.B De |
| 1170 |
and |
| 1171 |
.BR Df . |
| 1172 |
. |
| 1173 |
. |
| 1174 |
.TP |
| 1175 |
.BR DL \~[\c |
| 1176 |
.IR text-indent \~[\c |
| 1177 |
.BR 1 ]] |
| 1178 |
Begin dashed list. |
| 1179 |
. |
| 1180 |
Items are prefixed with an em dash and a space. |
| 1181 |
. |
| 1182 |
A |
| 1183 |
.I text-indent |
| 1184 |
argument overrides register |
| 1185 |
.BR Pi . |
| 1186 |
. |
| 1187 |
A second argument suppresses blank lines between items. |
| 1188 |
. |
| 1189 |
Use |
| 1190 |
.B LI |
| 1191 |
to declare list items, |
| 1192 |
and |
| 1193 |
.B LE |
| 1194 |
to end the list. |
| 1195 |
. |
| 1196 |
. |
| 1197 |
.TP |
| 1198 |
.BR DS \~[\c |
| 1199 |
.IR format \~[\c |
| 1200 |
.IR fill \~[\c |
| 1201 |
.IR right-indentation ]]] |
| 1202 |
Begin static display. |
| 1203 |
. |
| 1204 |
Input until |
| 1205 |
.B DE |
| 1206 |
is called is collected into a display. |
| 1207 |
. |
| 1208 |
The display is output on a single page unless it is taller than the |
| 1209 |
height of the page. |
| 1210 |
. |
| 1211 |
.B DS |
| 1212 |
can be nested |
| 1213 |
(contrast with |
| 1214 |
.BR DF ). |
| 1215 |
. |
| 1216 |
. |
| 1217 |
.IP |
| 1218 |
.TS |
| 1219 |
tab(@); |
| 1220 |
Lf(BI) Lb |
| 1221 |
L Lx. |
| 1222 |
format@Effect |
| 1223 |
\f[I]none\f[]@Do not indent the display. |
| 1224 |
L@Do not indent the display. |
| 1225 |
I@T{ |
| 1226 |
Indent text by |
| 1227 |
.BR \[rs]n[Si] . |
| 1228 |
T} |
| 1229 |
C@Center each line. |
| 1230 |
CB@Center the whole display as a block. |
| 1231 |
R@Right-adjust the lines. |
| 1232 |
RB@Right-adjust the whole display as a block. |
| 1233 |
.TE |
| 1234 |
. |
| 1235 |
. |
| 1236 |
.IP |
| 1237 |
The values \[lq]L\[rq], |
| 1238 |
\[lq]I\[rq], |
| 1239 |
\[lq]C\[rq], |
| 1240 |
and \[lq]CB\[rq] can also be specified as \[lq]0\[rq], |
| 1241 |
\[lq]1\[rq], |
| 1242 |
\[lq]2\[rq], |
| 1243 |
and |
| 1244 |
\[lq]3\[rq], |
| 1245 |
respectively, |
| 1246 |
for compatibility with |
| 1247 |
.RI DWB\~ mm. |
| 1248 |
. |
| 1249 |
. |
| 1250 |
.IP |
| 1251 |
.TS |
| 1252 |
tab(@); |
| 1253 |
Lf(BI) Lb |
| 1254 |
L Lx. |
| 1255 |
fill@Effect |
| 1256 |
\f[I]none\f[]@Disable filling. |
| 1257 |
N@Disable filling. |
| 1258 |
F@Enable filling. |
| 1259 |
.TE |
| 1260 |
. |
| 1261 |
. |
| 1262 |
.IP |
| 1263 |
\[lq]N\[rq] and \[lq]F\[rq] can also be specified as \[lq]0\[rq] and |
| 1264 |
\[lq]1\[rq], |
| 1265 |
respectively, |
| 1266 |
for compatibility with |
| 1267 |
.RI DWB\~ mm. |
| 1268 |
. |
| 1269 |
. |
| 1270 |
.IP |
| 1271 |
A third argument |
| 1272 |
reduces the line length by |
| 1273 |
.I right-indentation. |
| 1274 |
. |
| 1275 |
. |
| 1276 |
.IP |
| 1277 |
.I mm |
| 1278 |
normally |
| 1279 |
places blank lines before and after the display. |
| 1280 |
. |
| 1281 |
Set register |
| 1282 |
.B Ds |
| 1283 |
to\~0 to suppress these. |
| 1284 |
. |
| 1285 |
. |
| 1286 |
.TP |
| 1287 |
.BR EC \~\c |
| 1288 |
.RI [ title \~[ override \~[ flag \~[ refname ]]]] |
| 1289 |
Caption an equation. |
| 1290 |
. |
| 1291 |
The caption consists of the string |
| 1292 |
.B Liec |
| 1293 |
followed by an automatically incrementing counter stored in the register |
| 1294 |
.BR Ec , |
| 1295 |
punctuation configured by the register |
| 1296 |
.BR Of , |
| 1297 |
then |
| 1298 |
.I title |
| 1299 |
(if any). |
| 1300 |
. |
| 1301 |
Use the |
| 1302 |
.B af |
| 1303 |
request to configure |
| 1304 |
.BR Ec 's |
| 1305 |
number format. |
| 1306 |
. |
| 1307 |
.I override |
| 1308 |
and |
| 1309 |
.I flag |
| 1310 |
alter the equation number as follows. |
| 1311 |
. |
| 1312 |
Omitting |
| 1313 |
.I flag |
| 1314 |
and specifying |
| 1315 |
.B 0 |
| 1316 |
in its place are equivalent. |
| 1317 |
. |
| 1318 |
. |
| 1319 |
.IP |
| 1320 |
.TS |
| 1321 |
tab(@); |
| 1322 |
Lf(BI) Lb |
| 1323 |
L Lx. |
| 1324 |
flag@Effect |
| 1325 |
0@T{ |
| 1326 |
Prefix number with |
| 1327 |
.IR override . |
| 1328 |
T} |
| 1329 |
1@T{ |
| 1330 |
Suffix number with |
| 1331 |
.IR override . |
| 1332 |
T} |
| 1333 |
2@T{ |
| 1334 |
Replace number with |
| 1335 |
.IR override . |
| 1336 |
T} |
| 1337 |
.TE |
| 1338 |
. |
| 1339 |
. |
| 1340 |
.IP |
| 1341 |
Equation captions are centered irrespective of the alignment of any |
| 1342 |
enclosing display. |
| 1343 |
. |
| 1344 |
. |
| 1345 |
.IP |
| 1346 |
.I refname |
| 1347 |
stores the equation number using |
| 1348 |
.BR SETR ; |
| 1349 |
it can be retreived with |
| 1350 |
.RB \[lq] .GETST |
| 1351 |
.IR refname \[rq]. |
| 1352 |
. |
| 1353 |
This argument is a GNU extension. |
| 1354 |
. |
| 1355 |
. |
| 1356 |
.IP |
| 1357 |
Captioned equations are listed in a table of contents |
| 1358 |
(see |
| 1359 |
.BR TC ) |
| 1360 |
if the Boolean register |
| 1361 |
.B Le |
| 1362 |
is true. |
| 1363 |
. |
| 1364 |
Such a list uses the string |
| 1365 |
.B Le |
| 1366 |
as a heading. |
| 1367 |
. |
| 1368 |
. |
| 1369 |
.TP |
| 1370 |
.BR EF\~ [ \[dq]\|\[aq]\c |
| 1371 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 1372 |
] |
| 1373 |
Define the even-page footer, |
| 1374 |
which is formatted just above the normal page footer on even-numbered |
| 1375 |
pages. |
| 1376 |
. |
| 1377 |
See |
| 1378 |
.BR PF . |
| 1379 |
. |
| 1380 |
.B EF |
| 1381 |
defines the string |
| 1382 |
.BR EOPef . |
| 1383 |
. |
| 1384 |
. |
| 1385 |
.TP |
| 1386 |
.BR EH\~ [ \[dq]\|\[aq]\c |
| 1387 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 1388 |
] |
| 1389 |
Define the even-page header, |
| 1390 |
which is formatted just below the normal page header on even-numbered |
| 1391 |
pages. |
| 1392 |
. |
| 1393 |
See |
| 1394 |
.BR PH . |
| 1395 |
. |
| 1396 |
.B EH |
| 1397 |
defines the string |
| 1398 |
.BR TPeh . |
| 1399 |
. |
| 1400 |
. |
| 1401 |
.TP |
| 1402 |
.B EN |
| 1403 |
End equation input preprocessed by |
| 1404 |
.MR \%eqn 1 ; |
| 1405 |
see |
| 1406 |
.BR EQ . |
| 1407 |
. |
| 1408 |
. |
| 1409 |
.TP |
| 1410 |
.B EOP |
| 1411 |
If defined, |
| 1412 |
this macro is called in lieu of normal page footer layout. |
| 1413 |
. |
| 1414 |
Headers and footers are formatted in a separate environment. |
| 1415 |
. |
| 1416 |
See |
| 1417 |
.BR TP . |
| 1418 |
. |
| 1419 |
. |
| 1420 |
.IP |
| 1421 |
.TS |
| 1422 |
tab(@); |
| 1423 |
Cb S |
| 1424 |
Lb L. |
| 1425 |
Strings available to EOP |
| 1426 |
_ |
| 1427 |
EOPf@argument to \fBPF\fP |
| 1428 |
EOPef@argument to \fBEF\fP |
| 1429 |
EOPof@argument to \fBOF\fP |
| 1430 |
.TE |
| 1431 |
. |
| 1432 |
. |
| 1433 |
.TP |
| 1434 |
.BI EPIC\ "\fR[\fP\fB\-L\fP\fR]\fP width height \fR[\fPname\fR]\fP" |
| 1435 |
Draw a box with the given |
| 1436 |
.I width |
| 1437 |
and |
| 1438 |
.IR height . |
| 1439 |
. |
| 1440 |
It also prints the text |
| 1441 |
.I name |
| 1442 |
or a default string if |
| 1443 |
.I name |
| 1444 |
is not specified. |
| 1445 |
. |
| 1446 |
This is used to include external pictures; |
| 1447 |
just give the size of the picture. |
| 1448 |
. |
| 1449 |
.B \-L |
| 1450 |
left-aligns the picture; |
| 1451 |
the default is to center. |
| 1452 |
. |
| 1453 |
See |
| 1454 |
.BR PIC . |
| 1455 |
. |
| 1456 |
. |
| 1457 |
.TP |
| 1458 |
.BR EQ \~[\c |
| 1459 |
.IR label ] |
| 1460 |
Start equation input preprocessed by |
| 1461 |
.MR \%eqn 1 . |
| 1462 |
. |
| 1463 |
.B EQ |
| 1464 |
and |
| 1465 |
.B EN |
| 1466 |
macro calls bracket an equation region. |
| 1467 |
. |
| 1468 |
Such regions must be contained in displays |
| 1469 |
.RB ( DS / DE ), |
| 1470 |
except when the region is used only to configure |
| 1471 |
.I \%eqn |
| 1472 |
and not to produce output. |
| 1473 |
. |
| 1474 |
If present, |
| 1475 |
.I label |
| 1476 |
appears aligned to the right and |
| 1477 |
centered vertically within the display; |
| 1478 |
see register |
| 1479 |
.BR Eq . |
| 1480 |
. |
| 1481 |
. |
| 1482 |
If multiple |
| 1483 |
.I eqn \" generic |
| 1484 |
regions occur within a display, |
| 1485 |
only the last |
| 1486 |
.I label |
| 1487 |
(if any) |
| 1488 |
is used. |
| 1489 |
. |
| 1490 |
. |
| 1491 |
.TP |
| 1492 |
.BR EX \~\c |
| 1493 |
.RI [ title \~[ override \~[ flag \~[ refname ]]]] |
| 1494 |
Caption an exhibit. |
| 1495 |
. |
| 1496 |
Arguments are handled analogously to |
| 1497 |
.BR EC . |
| 1498 |
. |
| 1499 |
The register |
| 1500 |
.B Ex |
| 1501 |
is the exhibit counter. |
| 1502 |
. |
| 1503 |
The string |
| 1504 |
.B Liex |
| 1505 |
precedes the exhibit number and any |
| 1506 |
.I title. |
| 1507 |
. |
| 1508 |
Exhibit captions are centered irrespective of the alignment of any |
| 1509 |
enclosing display. |
| 1510 |
. |
| 1511 |
. |
| 1512 |
.IP |
| 1513 |
Captioned exhibits are listed in a table of contents |
| 1514 |
(see |
| 1515 |
.BR TC ) |
| 1516 |
if the Boolean register |
| 1517 |
.B Lx |
| 1518 |
is true. |
| 1519 |
. |
| 1520 |
Such a list uses the string |
| 1521 |
.B Lx |
| 1522 |
as a heading. |
| 1523 |
. |
| 1524 |
. |
| 1525 |
.TP |
| 1526 |
.BR FC \~[\c |
| 1527 |
.IR closing-text ] |
| 1528 |
Output the string |
| 1529 |
.BR Letfc , |
| 1530 |
or the specified |
| 1531 |
.I closing-text, |
| 1532 |
as the formal closing of a letter. |
| 1533 |
. |
| 1534 |
. |
| 1535 |
.TP |
| 1536 |
.BR FD \~[\c |
| 1537 |
.IR arg \~[\c |
| 1538 |
.BR 1 ]] |
| 1539 |
Configure display of footnotes. |
| 1540 |
. |
| 1541 |
The first argument encodes enablement of |
| 1542 |
automatic hyphenation, |
| 1543 |
adjustment to the right margin, |
| 1544 |
indentation of footnote text, |
| 1545 |
and left- vs.\& right-alignment of the footnote label within the space |
| 1546 |
allocated for it. |
| 1547 |
. |
| 1548 |
. |
| 1549 |
.br |
| 1550 |
.ne 5v |
| 1551 |
.IP |
| 1552 |
.\" XXX: We can fit one more row using "nokeep" vs. not using it. |
| 1553 |
.TS |
| 1554 |
tab(@) nokeep; |
| 1555 |
Lf(BI) Lb Lb Lb Lb |
| 1556 |
L L L L L. |
| 1557 |
arg@Hyphenate?@Adjust?@Indent?@Label alignment |
| 1558 |
0@no@yes@yes@left |
| 1559 |
1@yes@yes@yes@left |
| 1560 |
2@no@no@yes@left |
| 1561 |
3@yes@no@yes@left |
| 1562 |
4@no@yes@no@left |
| 1563 |
5@yes@yes@no@left |
| 1564 |
6@no@no@no@left |
| 1565 |
7@yes@no@no@left |
| 1566 |
8@no@yes@yes@right |
| 1567 |
9@yes@yes@yes@right |
| 1568 |
10@no@no@yes@right |
| 1569 |
11@yes@no@yes@right |
| 1570 |
.TE |
| 1571 |
. |
| 1572 |
. |
| 1573 |
.IP |
| 1574 |
An |
| 1575 |
.I arg |
| 1576 |
greater than 11 is treated |
| 1577 |
.RB as\~ 0 . |
| 1578 |
. |
| 1579 |
.IR mm 's |
| 1580 |
default |
| 1581 |
.RB is\~ 0 . |
| 1582 |
. |
| 1583 |
. |
| 1584 |
.IP |
| 1585 |
If a second argument, |
| 1586 |
conventionally |
| 1587 |
.BR 1 , |
| 1588 |
is given, |
| 1589 |
footnote numbering is reset when a first-level heading is encountered. |
| 1590 |
. |
| 1591 |
See |
| 1592 |
.BR FS . |
| 1593 |
. |
| 1594 |
. |
| 1595 |
.TP |
| 1596 |
.B FE |
| 1597 |
End footnote; |
| 1598 |
see |
| 1599 |
.BR FS . |
| 1600 |
. |
| 1601 |
. |
| 1602 |
.TP |
| 1603 |
.BR FG \~\c |
| 1604 |
.RI [ title \~[ override \~[ flag \~[ refname ]]]] |
| 1605 |
Caption a figure. |
| 1606 |
. |
| 1607 |
Arguments are handled analogously to |
| 1608 |
.BR EC . |
| 1609 |
. |
| 1610 |
The register |
| 1611 |
.B Fg |
| 1612 |
is the figure counter. |
| 1613 |
. |
| 1614 |
The string |
| 1615 |
.B Lifg |
| 1616 |
precedes the figure number and any |
| 1617 |
.I title. |
| 1618 |
. |
| 1619 |
Figure captions are centered irrespective of the alignment of any |
| 1620 |
enclosing display. |
| 1621 |
. |
| 1622 |
. |
| 1623 |
.IP |
| 1624 |
Captioned figures are listed in a table of contents |
| 1625 |
(see |
| 1626 |
.BR TC ) |
| 1627 |
if the Boolean register |
| 1628 |
.B Lf |
| 1629 |
is true. |
| 1630 |
. |
| 1631 |
Such a list uses the string |
| 1632 |
.B Lf |
| 1633 |
as a heading. |
| 1634 |
. |
| 1635 |
. |
| 1636 |
.TP |
| 1637 |
.BR FS \~[\c |
| 1638 |
.IR label ] |
| 1639 |
Start footnote. |
| 1640 |
. |
| 1641 |
Input until |
| 1642 |
.B FE |
| 1643 |
is called is collected into a footnote. |
| 1644 |
. |
| 1645 |
By default, |
| 1646 |
footnotes are automatically numbered starting at 1; |
| 1647 |
the number is available in register |
| 1648 |
.B :p |
| 1649 |
and, |
| 1650 |
with a trailing period, |
| 1651 |
in |
| 1652 |
.RB string\~ F . |
| 1653 |
. |
| 1654 |
This string precedes the footnote text at the bottom of the column or |
| 1655 |
page. |
| 1656 |
. |
| 1657 |
Footnotes are vertically separated by the product of |
| 1658 |
.RB registers\~ Fs |
| 1659 |
and |
| 1660 |
.BR Lsp . |
| 1661 |
. |
| 1662 |
In |
| 1663 |
.IR "groff mm" , |
| 1664 |
footnotes may be used in displays. |
| 1665 |
. |
| 1666 |
. |
| 1667 |
.IP |
| 1668 |
A |
| 1669 |
.I label |
| 1670 |
argument replaces the contents of the string |
| 1671 |
.BR F ; |
| 1672 |
it need not be numeric. |
| 1673 |
. |
| 1674 |
In this event, |
| 1675 |
the footnote marker in the body text must be explicitly written. |
| 1676 |
. |
| 1677 |
. |
| 1678 |
.TP |
| 1679 |
.BI GETHN\ "refname \fR[\fPvarname\fR]\fP" |
| 1680 |
Include the heading number where the corresponding |
| 1681 |
.RB \[lq] .SETR |
| 1682 |
.IR refname \[rq] |
| 1683 |
was placed. |
| 1684 |
. |
| 1685 |
This is displayed as \[lq]X.X.X.\[rq] in pass\~1. |
| 1686 |
. |
| 1687 |
See |
| 1688 |
.BR INITR . |
| 1689 |
. |
| 1690 |
If |
| 1691 |
.I varname |
| 1692 |
is used, |
| 1693 |
.B GETHN |
| 1694 |
sets the string |
| 1695 |
.I varname |
| 1696 |
to the heading number. |
| 1697 |
. |
| 1698 |
.TP |
| 1699 |
.BI GETPN\ "refname \fR[\fPvarname\fR]\fP" |
| 1700 |
Include the page number where the corresponding |
| 1701 |
.RB \[lq] .SETR |
| 1702 |
.IR refname \[rq] |
| 1703 |
was placed. |
| 1704 |
. |
| 1705 |
This is displayed as \[lq]9999\[rq] in pass\~1. |
| 1706 |
. |
| 1707 |
See |
| 1708 |
.BR INITR . |
| 1709 |
. |
| 1710 |
If |
| 1711 |
.I varname |
| 1712 |
is used, |
| 1713 |
.B GETPN |
| 1714 |
sets the string |
| 1715 |
.I varname |
| 1716 |
to the page number. |
| 1717 |
. |
| 1718 |
.TP |
| 1719 |
.BI GETR\ refname |
| 1720 |
Combine |
| 1721 |
.B GETHN |
| 1722 |
and |
| 1723 |
.B GETPN |
| 1724 |
with the text \[lq]chapter\[rq] and \[lq],\~page\[rq]. |
| 1725 |
. |
| 1726 |
The string |
| 1727 |
.B Qrf |
| 1728 |
contains the text for the cross reference: |
| 1729 |
. |
| 1730 |
.RS |
| 1731 |
.IP |
| 1732 |
\&.ds Qrf See chapter \[rs]\[rs]*[Qrfh], page \[rs]\[rs]*[Qrfp]. |
| 1733 |
.RE |
| 1734 |
. |
| 1735 |
.IP |
| 1736 |
.B Qrf |
| 1737 |
may be changed to support other languages. |
| 1738 |
. |
| 1739 |
Strings |
| 1740 |
.B Qrfh |
| 1741 |
and |
| 1742 |
.B Qrfp |
| 1743 |
are set by |
| 1744 |
.B GETR |
| 1745 |
and contain the page and heading number, |
| 1746 |
respectively. |
| 1747 |
. |
| 1748 |
.TP |
| 1749 |
.BI GETST\ "refname \fR[\fPvarname\fR]\fP" |
| 1750 |
Include the string saved with the second argument to |
| 1751 |
.BR .SETR . |
| 1752 |
. |
| 1753 |
This is a dummy string in pass\~1. |
| 1754 |
. |
| 1755 |
If |
| 1756 |
.I varname |
| 1757 |
is used, |
| 1758 |
.B GETST |
| 1759 |
sets it to the saved string. |
| 1760 |
. |
| 1761 |
See |
| 1762 |
.BR INITR . |
| 1763 |
. |
| 1764 |
. |
| 1765 |
.TP |
| 1766 |
.BI H\~ level\~\c |
| 1767 |
.RI [ title \~[ suffix ]] |
| 1768 |
Set a numbered section heading at |
| 1769 |
.IR level . |
| 1770 |
. |
| 1771 |
.I mm |
| 1772 |
produces numbered |
| 1773 |
.I "heading marks" |
| 1774 |
of the form |
| 1775 |
.IR a . b . c .\|.\|., |
| 1776 |
with up to fourteen levels of nesting. |
| 1777 |
. |
| 1778 |
Each level's number increases automatically with each |
| 1779 |
.B H |
| 1780 |
call and is reset to zero when a more significant |
| 1781 |
.I level |
| 1782 |
is specified. |
| 1783 |
. |
| 1784 |
.RB \[lq] 1 \[rq]\~is |
| 1785 |
the most significant or coarsest division of the document. |
| 1786 |
. |
| 1787 |
Text after an |
| 1788 |
.B H |
| 1789 |
call is formatted as a paragraph; |
| 1790 |
calling |
| 1791 |
.B P |
| 1792 |
is unnecessary. |
| 1793 |
. |
| 1794 |
. |
| 1795 |
.IP |
| 1796 |
.I title |
| 1797 |
specifies an optional title; |
| 1798 |
it must be double-quoted if it contains spaces. |
| 1799 |
. |
| 1800 |
.I mm |
| 1801 |
appends |
| 1802 |
.I suffix |
| 1803 |
to |
| 1804 |
.I title |
| 1805 |
in the body of the document, |
| 1806 |
but omits it from any table of contents |
| 1807 |
(see |
| 1808 |
.BR TC ). |
| 1809 |
. |
| 1810 |
This facility can be used to annotate the heading title with a footnote. |
| 1811 |
. |
| 1812 |
.I suffix |
| 1813 |
should not interpolate |
| 1814 |
.RB the\~ F |
| 1815 |
string; |
| 1816 |
specify a footnote mark explicitly. |
| 1817 |
. |
| 1818 |
See |
| 1819 |
.BR FS . |
| 1820 |
. |
| 1821 |
. |
| 1822 |
.IP |
| 1823 |
Heading behavior is highly configurable. |
| 1824 |
. |
| 1825 |
Several registers set a |
| 1826 |
.I threshold, |
| 1827 |
where heading levels at or below the threshold value are handled in one |
| 1828 |
way, |
| 1829 |
and those above it another. |
| 1830 |
. |
| 1831 |
For example, |
| 1832 |
a heading level within the threshold of register |
| 1833 |
.B Cl |
| 1834 |
is included in the table of contents |
| 1835 |
(see |
| 1836 |
.BR TC ). |
| 1837 |
. |
| 1838 |
. |
| 1839 |
.IP |
| 1840 |
.I Heading layout. |
| 1841 |
. |
| 1842 |
Register |
| 1843 |
.B Ej |
| 1844 |
sets a threshold for page breaking (ejection) prior to a heading. |
| 1845 |
. |
| 1846 |
If not preceded by a page break, |
| 1847 |
a heading level below the threshold in register |
| 1848 |
.B Hps |
| 1849 |
is preceded by the amount of vertical space in register |
| 1850 |
.BR Hps1 , |
| 1851 |
and by the amount in |
| 1852 |
.B Hps2 |
| 1853 |
otherwise. |
| 1854 |
. |
| 1855 |
The |
| 1856 |
.B Hb |
| 1857 |
register sets a threshold below which a break occurs after the heading, |
| 1858 |
and register |
| 1859 |
.B Hs |
| 1860 |
sets a threshold below which vertical space follows it. |
| 1861 |
. |
| 1862 |
If the heading level is not less than both of these, |
| 1863 |
a |
| 1864 |
.I run-in heading |
| 1865 |
is produced; |
| 1866 |
paragraph text follows on the same output line. |
| 1867 |
. |
| 1868 |
Otherwise, |
| 1869 |
register |
| 1870 |
.B Hi |
| 1871 |
configures the indentation of text after headings. |
| 1872 |
. |
| 1873 |
Threshold register |
| 1874 |
.B Hc |
| 1875 |
enables the centering of headings; |
| 1876 |
a heading level below both of the |
| 1877 |
.B Hb |
| 1878 |
and |
| 1879 |
.B Hc |
| 1880 |
thresholds is centered. |
| 1881 |
. |
| 1882 |
. |
| 1883 |
.IP |
| 1884 |
.I Heading typeface and size. |
| 1885 |
. |
| 1886 |
The fonts used for heading numbers and titles at each level are |
| 1887 |
configured by the |
| 1888 |
.B HF |
| 1889 |
string. |
| 1890 |
. |
| 1891 |
The string |
| 1892 |
.B HP |
| 1893 |
likewise assigns a type size to each heading level. |
| 1894 |
. |
| 1895 |
.\" XXX: Why not an "Hvs" string? |
| 1896 |
The vertical spacing used by headings may be controlled by |
| 1897 |
the user-definable macros |
| 1898 |
.B HX |
| 1899 |
and/or |
| 1900 |
.BR HZ . |
| 1901 |
. |
| 1902 |
. |
| 1903 |
.IP |
| 1904 |
.I Heading number format. |
| 1905 |
. |
| 1906 |
Registers named |
| 1907 |
.B H1 |
| 1908 |
through |
| 1909 |
.B H14 |
| 1910 |
store counters for each heading level. |
| 1911 |
. |
| 1912 |
Their values are printed using Arabic numerals by default; |
| 1913 |
see |
| 1914 |
.BR HM . |
| 1915 |
. |
| 1916 |
The heading levels are catenated with dots for formatting; |
| 1917 |
to typeset only the deepest, |
| 1918 |
set the |
| 1919 |
.B Ht |
| 1920 |
register. |
| 1921 |
. |
| 1922 |
Heading numbers are not suffixed with a trailing dot except when only |
| 1923 |
the first level is output; |
| 1924 |
to omit a dot in this case as well, |
| 1925 |
clear the |
| 1926 |
.B H1dot |
| 1927 |
register. |
| 1928 |
. |
| 1929 |
. |
| 1930 |
.IP |
| 1931 |
.I Customizing heading behavior. |
| 1932 |
. |
| 1933 |
.I mm |
| 1934 |
calls |
| 1935 |
.I hook |
| 1936 |
macros to enable further customization of headings. |
| 1937 |
. |
| 1938 |
(DWB |
| 1939 |
.I mm |
| 1940 |
called these \[lq]exits\[rq].) |
| 1941 |
. |
| 1942 |
They can be used to change the heading's |
| 1943 |
.I mark |
| 1944 |
(the numbered portion before any heading title), |
| 1945 |
its vertical spacing, |
| 1946 |
and its vertical space requirements |
| 1947 |
(for instance, |
| 1948 |
to require a minimum quantity of subsequent output lines). |
| 1949 |
. |
| 1950 |
Define hook macros in expectation of the following parameters. |
| 1951 |
. |
| 1952 |
The argument |
| 1953 |
.I declared-level |
| 1954 |
is the |
| 1955 |
.I level |
| 1956 |
argument to |
| 1957 |
.BR H , |
| 1958 |
.RB or\~ 0 |
| 1959 |
for unnumbered headings (see |
| 1960 |
.BR HU ). |
| 1961 |
. |
| 1962 |
.I actual-level |
| 1963 |
is the same as |
| 1964 |
.I declared-level |
| 1965 |
for numbered headings, |
| 1966 |
and the value of |
| 1967 |
.RB register\~ Hu |
| 1968 |
for unnumbered headings. |
| 1969 |
. |
| 1970 |
.I title |
| 1971 |
is the corresponding argument to |
| 1972 |
.B H |
| 1973 |
or |
| 1974 |
.BR HU . |
| 1975 |
. |
| 1976 |
. |
| 1977 |
.RS |
| 1978 |
.TP |
| 1979 |
.BI HX\~ "declared-level actual-level title" |
| 1980 |
.I mm |
| 1981 |
calls |
| 1982 |
.B HX |
| 1983 |
before setting the heading. |
| 1984 |
. |
| 1985 |
Your definition may alter |
| 1986 |
.BR }0 , |
| 1987 |
.BR }2 , |
| 1988 |
and |
| 1989 |
.BR ;3 . |
| 1990 |
. |
| 1991 |
. |
| 1992 |
.\" XXX: These names are ugly and of no obvious meaning. Make |
| 1993 |
.\" documented aliases for them. |
| 1994 |
.RS |
| 1995 |
.TP |
| 1996 |
.BR }0\~ (string) |
| 1997 |
contains the heading mark plus two spaces if |
| 1998 |
.I declared-level |
| 1999 |
is non-zero, |
| 2000 |
and otherwise is empty. |
| 2001 |
. |
| 2002 |
. |
| 2003 |
.TP |
| 2004 |
.BR ;0\~ (register) |
| 2005 |
encodes a position for the text after the heading. |
| 2006 |
. |
| 2007 |
0\~means that the heading is to be run in, |
| 2008 |
1\~means that a break is to occur before the text, |
| 2009 |
and 2\~means that vertical space is to separate heading and text. |
| 2010 |
. |
| 2011 |
. |
| 2012 |
.TP |
| 2013 |
.BR }2\~ (string) |
| 2014 |
is the suffix that separates a run-in heading from the text. |
| 2015 |
. |
| 2016 |
It contains two spaces if register |
| 2017 |
.B ;0 |
| 2018 |
is\~0, |
| 2019 |
and otherwise is empty. |
| 2020 |
. |
| 2021 |
. |
| 2022 |
.TP |
| 2023 |
.BR ;3\~ (register) |
| 2024 |
contains the vertical space required for the heading to be typeset. |
| 2025 |
. |
| 2026 |
If that amount is not available, |
| 2027 |
the page is broken prior to the heading. |
| 2028 |
. |
| 2029 |
The default is |
| 2030 |
.BR 2v . |
| 2031 |
.RE |
| 2032 |
. |
| 2033 |
. |
| 2034 |
.TP |
| 2035 |
.BI HY\~ "declared-level actual-level title" |
| 2036 |
.I mm |
| 2037 |
calls |
| 2038 |
.B HY |
| 2039 |
after determing the heading typeface and size. |
| 2040 |
. |
| 2041 |
It could be used to change indentation. |
| 2042 |
. |
| 2043 |
. |
| 2044 |
.TP |
| 2045 |
.BI HZ\~ "declared-level actual-level title" |
| 2046 |
.I mm |
| 2047 |
calls |
| 2048 |
.B HZ |
| 2049 |
after formatting the heading, |
| 2050 |
just before |
| 2051 |
.B H |
| 2052 |
or |
| 2053 |
.B HU |
| 2054 |
returns. |
| 2055 |
. |
| 2056 |
It could be used to change the page header to include a section heading. |
| 2057 |
.\" XXX: ...but only for the _next_ page, not the current one. See |
| 2058 |
.\" Savannah #62825. |
| 2059 |
.RE |
| 2060 |
. |
| 2061 |
. |
| 2062 |
.TP |
| 2063 |
.BI HC\ \fR[\fPhyphenation-character\fR]\fP |
| 2064 |
Set hyphenation character. |
| 2065 |
. |
| 2066 |
Default value is \[lq]\[rs]%\[rq]. |
| 2067 |
. |
| 2068 |
Resets to the default if called without argument. |
| 2069 |
. |
| 2070 |
Hyphenation can be turned off by setting register |
| 2071 |
.B Hy |
| 2072 |
to\~0 at the beginning of the file. |
| 2073 |
. |
| 2074 |
. |
| 2075 |
.TP |
| 2076 |
.BI HM\ "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP" |
| 2077 |
Set the heading mark style. |
| 2078 |
. |
| 2079 |
Each argument assigns the specified register format |
| 2080 |
(see above) |
| 2081 |
to the corresponding heading level. |
| 2082 |
. |
| 2083 |
The default |
| 2084 |
.RB is\~ 1 |
| 2085 |
for all levels. |
| 2086 |
. |
| 2087 |
An explicitly empty argument also indicates the default. |
| 2088 |
. |
| 2089 |
. |
| 2090 |
.TP |
| 2091 |
.BI HU\~ heading-text |
| 2092 |
Set an unnumbered section heading. |
| 2093 |
. |
| 2094 |
Except for a heading number, |
| 2095 |
it is treated as a numbered heading of the level stored in |
| 2096 |
.RB register\~ Hu ; |
| 2097 |
.RB see\~ H . |
| 2098 |
. |
| 2099 |
. |
| 2100 |
.TP |
| 2101 |
.BR I \~\c \" space in roman; we must use 2-font macro with \c |
| 2102 |
.RI [ italic-text\~\c |
| 2103 |
.RI [ previous-font-text ]]\~.\|.\|. |
| 2104 |
Join |
| 2105 |
.I italic-text |
| 2106 |
in italics with |
| 2107 |
.I previous-font-text |
| 2108 |
in the previous font, |
| 2109 |
without space between the arguments. |
| 2110 |
. |
| 2111 |
If no arguments, |
| 2112 |
switch font to italic style. |
| 2113 |
. |
| 2114 |
. |
| 2115 |
.TP |
| 2116 |
.BR IA \~[\c |
| 2117 |
.IR recipient-name \~[\c |
| 2118 |
.IR title ]] |
| 2119 |
Specify the inside address in a letter. |
| 2120 |
. |
| 2121 |
Input is collected into the inside address until |
| 2122 |
.B IE |
| 2123 |
is called, |
| 2124 |
and then output. |
| 2125 |
. |
| 2126 |
You can specify multiple recipients with empty |
| 2127 |
.BR IA / IE |
| 2128 |
pairs; |
| 2129 |
only the last address is used. |
| 2130 |
. |
| 2131 |
The arguments give each recipient a name and title. |
| 2132 |
. |
| 2133 |
See |
| 2134 |
.BR LT . |
| 2135 |
. |
| 2136 |
. |
| 2137 |
.TP |
| 2138 |
.BR IB \~\c \" space in roman; we must use 2-font macro with \c |
| 2139 |
.RI [ italic-text\~\c |
| 2140 |
.RI [ bold-text ]]\~.\|.\|. |
| 2141 |
Join |
| 2142 |
.I italic-text |
| 2143 |
in italics with |
| 2144 |
.I bold-text |
| 2145 |
in boldface, |
| 2146 |
without space between the arguments. |
| 2147 |
. |
| 2148 |
. |
| 2149 |
.TP |
| 2150 |
.B IE |
| 2151 |
End the inside address begun with |
| 2152 |
.BR IA . |
| 2153 |
. |
| 2154 |
. |
| 2155 |
.TP |
| 2156 |
.BI IND\~ argument\~\c |
| 2157 |
\&.\|.\|. |
| 2158 |
If the Boolean register |
| 2159 |
.B Ref |
| 2160 |
is true, |
| 2161 |
write an index entry as a specially prepared |
| 2162 |
.I roff |
| 2163 |
comment to the standard error stream, |
| 2164 |
with each |
| 2165 |
.I argument |
| 2166 |
separated from its predecessor by a tab character. |
| 2167 |
. |
| 2168 |
The entry's location information is arranged as configured by the most |
| 2169 |
recent |
| 2170 |
.B INITI |
| 2171 |
call. |
| 2172 |
. |
| 2173 |
. |
| 2174 |
.TP |
| 2175 |
.B INDP |
| 2176 |
Output the index set up by |
| 2177 |
.B INITI |
| 2178 |
and populated by |
| 2179 |
.B IND |
| 2180 |
calls. |
| 2181 |
. |
| 2182 |
By default, |
| 2183 |
.B INDP |
| 2184 |
calls |
| 2185 |
.B SK |
| 2186 |
and writes a centered caption interpolating the string |
| 2187 |
.BR Index . |
| 2188 |
. |
| 2189 |
It then disables filling and calls |
| 2190 |
.BR 2C ; |
| 2191 |
afterward, |
| 2192 |
it restores filling and calls |
| 2193 |
.BR 1C . |
| 2194 |
. |
| 2195 |
. |
| 2196 |
.IP |
| 2197 |
Define macros to customize this behavior. |
| 2198 |
. |
| 2199 |
.B INDP |
| 2200 |
calls |
| 2201 |
.B TXIND |
| 2202 |
before the caption, |
| 2203 |
.B TYIND |
| 2204 |
.I instead |
| 2205 |
of writing the caption, |
| 2206 |
and |
| 2207 |
.B TZIND |
| 2208 |
after formatting the index. |
| 2209 |
. |
| 2210 |
. |
| 2211 |
.TP |
| 2212 |
.BI INITI\~ "location-type file-name\~"\c |
| 2213 |
.RI [ macro ] |
| 2214 |
Initialize |
| 2215 |
.IR "groff mm" 's |
| 2216 |
indexing system. |
| 2217 |
. |
| 2218 |
Argument |
| 2219 |
.I location-type |
| 2220 |
selects how the location of each index entry is reported. |
| 2221 |
. |
| 2222 |
.I file-name |
| 2223 |
populates an internal string used later by |
| 2224 |
.BR INDP . |
| 2225 |
. |
| 2226 |
. |
| 2227 |
.IP |
| 2228 |
.TS |
| 2229 |
tab(@); |
| 2230 |
Lf(BI) Lb |
| 2231 |
L Lx. |
| 2232 |
location-type@Entry format |
| 2233 |
N@page number |
| 2234 |
H@heading mark |
| 2235 |
B@page number, tab character, heading mark |
| 2236 |
.TE |
| 2237 |
. |
| 2238 |
. |
| 2239 |
.IP |
| 2240 |
If |
| 2241 |
.I macro |
| 2242 |
is specified, |
| 2243 |
it is called for each index entry |
| 2244 |
with the arguments given to |
| 2245 |
.BR IND . |
| 2246 |
. |
| 2247 |
. |
| 2248 |
.TP |
| 2249 |
.BI INITR\~ id |
| 2250 |
Initialize the cross reference macros. |
| 2251 |
. |
| 2252 |
Cross references are written to the standard error stream, |
| 2253 |
which should be redirected into a file named |
| 2254 |
.RI id .qrf . |
| 2255 |
. |
| 2256 |
.MR mmroff 1 |
| 2257 |
handles this and the two formatting passes it requires. |
| 2258 |
.\". |
| 2259 |
.\"This program exists because |
| 2260 |
.\".MR groff 1 |
| 2261 |
.\"by default deactivates the unsafe operations that are required by |
| 2262 |
.\".BR INITR . |
| 2263 |
. |
| 2264 |
The first pass identifies cross references, |
| 2265 |
and the second one includes them. |
| 2266 |
.\" |
| 2267 |
.\".B INITR |
| 2268 |
.\"can be used several times, |
| 2269 |
.\"but it is only the first occurrence of |
| 2270 |
.\".B INITR |
| 2271 |
.\"that is active. |
| 2272 |
. |
| 2273 |
. |
| 2274 |
.IP |
| 2275 |
See |
| 2276 |
.BR SETR , |
| 2277 |
.BR GETPN , |
| 2278 |
and |
| 2279 |
.BR GETHN . |
| 2280 |
. |
| 2281 |
. |
| 2282 |
.TP |
| 2283 |
.BR IR \~\c \" space in roman; we must use 2-font macro with \c |
| 2284 |
.RI [ italic-text\~\c |
| 2285 |
.RI [ roman-text ]]\~.\|.\|. |
| 2286 |
Join |
| 2287 |
.I italic-text |
| 2288 |
in italics with |
| 2289 |
.I roman-text |
| 2290 |
in roman style, |
| 2291 |
without space between the arguments. |
| 2292 |
. |
| 2293 |
. |
| 2294 |
.TP |
| 2295 |
.BR ISODATE\~ [ 0 ] |
| 2296 |
Use ISO\~8601 format for the date string |
| 2297 |
.B DT |
| 2298 |
used by some cover sheet and memorandum types; |
| 2299 |
that is, |
| 2300 |
.IR YYYY - MM - DD . |
| 2301 |
. |
| 2302 |
Must be called before |
| 2303 |
.B ND |
| 2304 |
to be effective. |
| 2305 |
. |
| 2306 |
If given an argument |
| 2307 |
.RB of\~ 0, |
| 2308 |
the traditional date format for the |
| 2309 |
.I groff |
| 2310 |
locale is used; |
| 2311 |
this is also the default. |
| 2312 |
. |
| 2313 |
. |
| 2314 |
.TP |
| 2315 |
.BI LB\~ "text-indent mark-indent pad type"\~\c |
| 2316 |
.RI [ mark \~[ pre-item-space \~[ pre-list-space ]]] |
| 2317 |
Begin list. |
| 2318 |
. |
| 2319 |
The macros |
| 2320 |
.BR AL , |
| 2321 |
.BR BL , |
| 2322 |
.BR BVL , |
| 2323 |
.BR DL , |
| 2324 |
.BR ML , |
| 2325 |
.BR RL , |
| 2326 |
and |
| 2327 |
.B VL |
| 2328 |
call |
| 2329 |
.B LB |
| 2330 |
in various ways; |
| 2331 |
they are simpler to use and may be preferred if they suit the desired |
| 2332 |
purpose. |
| 2333 |
. |
| 2334 |
. |
| 2335 |
.br |
| 2336 |
.ne 5v |
| 2337 |
.IP |
| 2338 |
The nesting level of lists is tracked by |
| 2339 |
.I mm; |
| 2340 |
the outermost level is\~0. |
| 2341 |
. |
| 2342 |
The text of each list item is indented by |
| 2343 |
.I text-indent; |
| 2344 |
the default is taken from the |
| 2345 |
.B Li |
| 2346 |
register |
| 2347 |
(in ens). |
| 2348 |
. |
| 2349 |
Each item's mark is indented by |
| 2350 |
.I mark-indent; |
| 2351 |
the default is |
| 2352 |
.BR 0n . |
| 2353 |
. |
| 2354 |
The mark is normally left-aligned. |
| 2355 |
. |
| 2356 |
If |
| 2357 |
.I pad |
| 2358 |
is greater than zero, |
| 2359 |
.I mark-indent |
| 2360 |
is overridden such that |
| 2361 |
.I pad |
| 2362 |
ens of space follow the mark. |
| 2363 |
. |
| 2364 |
.I type |
| 2365 |
selects one of six possible ways to display the mark. |
| 2366 |
. |
| 2367 |
. |
| 2368 |
.IP |
| 2369 |
.TS |
| 2370 |
tab(@); |
| 2371 |
Lf(BI) Lb |
| 2372 |
L L. |
| 2373 |
type@Output for a mark \[lq]x\[rq] |
| 2374 |
1@x. |
| 2375 |
2@x) |
| 2376 |
3@(x) |
| 2377 |
4@[x] |
| 2378 |
5@<x> |
| 2379 |
6@{x} |
| 2380 |
.TE |
| 2381 |
. |
| 2382 |
. |
| 2383 |
.IP |
| 2384 |
If |
| 2385 |
.I type |
| 2386 |
is\~0 and |
| 2387 |
.I mark |
| 2388 |
is unspecified, |
| 2389 |
the items are set with a hanging indent. |
| 2390 |
. |
| 2391 |
Otherwise, |
| 2392 |
.I mark |
| 2393 |
is interpreted as a string defining the mark. |
| 2394 |
. |
| 2395 |
If |
| 2396 |
.I type |
| 2397 |
is greater than zero, |
| 2398 |
items are automatically numbered; |
| 2399 |
.I mark |
| 2400 |
is interpreted as a register format. |
| 2401 |
. |
| 2402 |
The default |
| 2403 |
.I type |
| 2404 |
.RB is\~ 0 . |
| 2405 |
. |
| 2406 |
. |
| 2407 |
.IP |
| 2408 |
The last two arguments manage vertical space. |
| 2409 |
. |
| 2410 |
Unless a list's nesting level is greater than the value of register |
| 2411 |
.BR Ls , |
| 2412 |
its items are preceded by |
| 2413 |
.I pre-item-space |
| 2414 |
multiplied by the register |
| 2415 |
.BR Lsp ; |
| 2416 |
the default |
| 2417 |
.RB is\~ 1 . |
| 2418 |
. |
| 2419 |
.B LB |
| 2420 |
precedes the list by |
| 2421 |
.I pre-list-space |
| 2422 |
multiplied by the register |
| 2423 |
.BR Lsp ; |
| 2424 |
the default |
| 2425 |
.RB is\~ 0 . |
| 2426 |
. |
| 2427 |
. |
| 2428 |
.TP |
| 2429 |
.BR LC \~[\c |
| 2430 |
.IR list-level ] |
| 2431 |
Clear list state. |
| 2432 |
. |
| 2433 |
Active lists are terminated as if with |
| 2434 |
.BR LE , |
| 2435 |
either all |
| 2436 |
(the default) |
| 2437 |
or only those from the current level down to |
| 2438 |
.I list-level |
| 2439 |
if specified. |
| 2440 |
. |
| 2441 |
.B H |
| 2442 |
calls |
| 2443 |
.B LC |
| 2444 |
automatically. |
| 2445 |
. |
| 2446 |
. |
| 2447 |
.TP |
| 2448 |
.BR LE \~[ 1 ] |
| 2449 |
End list. |
| 2450 |
. |
| 2451 |
The current list is terminated. |
| 2452 |
. |
| 2453 |
An argument |
| 2454 |
.RB of\~ 1 |
| 2455 |
causes |
| 2456 |
vertical space in the amount of register |
| 2457 |
.B Lsp |
| 2458 |
to follow the list. |
| 2459 |
. |
| 2460 |
. |
| 2461 |
.TP |
| 2462 |
.BR LI \~[\c |
| 2463 |
.IR mark \~[ item-mark-mode ]] |
| 2464 |
Begin a list item. |
| 2465 |
. |
| 2466 |
Input is collected into a list item until the current list is terminated |
| 2467 |
or |
| 2468 |
.B LI |
| 2469 |
is called again. |
| 2470 |
. |
| 2471 |
By default, |
| 2472 |
the item's text is preceded by any mark configured by the current list. |
| 2473 |
. |
| 2474 |
If only |
| 2475 |
.I mark |
| 2476 |
is specified, |
| 2477 |
it replaces the configured mark. |
| 2478 |
. |
| 2479 |
A second argument |
| 2480 |
prefixes |
| 2481 |
.I mark |
| 2482 |
to the configured mark; |
| 2483 |
an |
| 2484 |
.I item-mark-mode |
| 2485 |
value of\~1 places an unbreakable space after |
| 2486 |
.I mark, |
| 2487 |
while |
| 2488 |
a value of\~2 does not |
| 2489 |
(rendering the two adjacent). |
| 2490 |
. |
| 2491 |
Also see register |
| 2492 |
.BR Limsp . |
| 2493 |
. |
| 2494 |
. |
| 2495 |
.TP |
| 2496 |
.BI LO\~ option\~\c |
| 2497 |
.RI [ value ] |
| 2498 |
Specify letter options; |
| 2499 |
see |
| 2500 |
.BR LT . |
| 2501 |
. |
| 2502 |
Standard options are as follows. |
| 2503 |
. |
| 2504 |
See |
| 2505 |
.B IA |
| 2506 |
regarding the inside address and string |
| 2507 |
.B DT |
| 2508 |
regarding the date. |
| 2509 |
. |
| 2510 |
. |
| 2511 |
.IP |
| 2512 |
.TS |
| 2513 |
tab(@); |
| 2514 |
Lf(BI) Lb |
| 2515 |
L Lx. |
| 2516 |
option@Effect |
| 2517 |
AT@T{ |
| 2518 |
Attention; |
| 2519 |
put contents of string |
| 2520 |
.B LetAT |
| 2521 |
and |
| 2522 |
.I value |
| 2523 |
left-aligned after the inside address. |
| 2524 |
T} |
| 2525 |
CN@T{ |
| 2526 |
Confidential; |
| 2527 |
put |
| 2528 |
.I value, |
| 2529 |
or contents of string |
| 2530 |
.BR LetCN , |
| 2531 |
left-aligned after the date. |
| 2532 |
T} |
| 2533 |
RN@T{ |
| 2534 |
Reference; |
| 2535 |
put contents of string |
| 2536 |
.B LetRN |
| 2537 |
and |
| 2538 |
.I value |
| 2539 |
after the confidental notation |
| 2540 |
(if any) |
| 2541 |
and the date, |
| 2542 |
aligned with the latter. |
| 2543 |
T} |
| 2544 |
SA@T{ |
| 2545 |
Salutation; |
| 2546 |
put |
| 2547 |
.I value, |
| 2548 |
or contents of string |
| 2549 |
.BR LetSA , |
| 2550 |
left-aligned after the inside address |
| 2551 |
and the confidental notation |
| 2552 |
(if any). |
| 2553 |
T} |
| 2554 |
SJ@T{ |
| 2555 |
Subject; |
| 2556 |
put contents of string |
| 2557 |
.B LetSJ |
| 2558 |
and |
| 2559 |
.I value |
| 2560 |
left-aligned after the inside address |
| 2561 |
and the attention and salutation notations |
| 2562 |
(if any). |
| 2563 |
. |
| 2564 |
In letter type \[lq]SP\[rq], |
| 2565 |
.B LetSJ |
| 2566 |
is ignored and |
| 2567 |
.I value |
| 2568 |
is set in full capitals. |
| 2569 |
T} |
| 2570 |
.TE |
| 2571 |
. |
| 2572 |
. |
| 2573 |
.br |
| 2574 |
.ne 5v |
| 2575 |
.TP |
| 2576 |
.BR LT \~[\c |
| 2577 |
.IR style ] |
| 2578 |
Format a letter in the designated |
| 2579 |
.I style, |
| 2580 |
defaulting to |
| 2581 |
.B BL |
| 2582 |
(see below). |
| 2583 |
. |
| 2584 |
A letter begins with the writer's address |
| 2585 |
.RB ( WA / WE ), |
| 2586 |
followed by the date |
| 2587 |
.RB ( ND ), |
| 2588 |
the inside address |
| 2589 |
.RB ( IA / IE ), |
| 2590 |
the body of the letter |
| 2591 |
.RB ( P |
| 2592 |
and other general-purpose |
| 2593 |
.I mm |
| 2594 |
macros), |
| 2595 |
the formal closing |
| 2596 |
.RB ( FC ), |
| 2597 |
the signature |
| 2598 |
.RB ( SG ), |
| 2599 |
and notations |
| 2600 |
.RB ( NS / NE ). |
| 2601 |
. |
| 2602 |
Any of these may be omitted. |
| 2603 |
. |
| 2604 |
Letter options specified with |
| 2605 |
.B LO |
| 2606 |
add further annotations, |
| 2607 |
which are extensible; |
| 2608 |
see section \[lq]Internals\[rq] below. |
| 2609 |
. |
| 2610 |
. |
| 2611 |
.br |
| 2612 |
.ne 6v |
| 2613 |
.IP |
| 2614 |
.TS |
| 2615 |
tab(@); |
| 2616 |
Lf(BI) Lb |
| 2617 |
Lb Lx. |
| 2618 |
style@Description |
| 2619 |
BL@T{ |
| 2620 |
Blocked: |
| 2621 |
the writer's address, |
| 2622 |
date, |
| 2623 |
formal closing, |
| 2624 |
and signature are indented to the center of the line. |
| 2625 |
. |
| 2626 |
Everything else is left-aligned. |
| 2627 |
T} |
| 2628 |
SB@T{ |
| 2629 |
Semi-blocked: |
| 2630 |
as |
| 2631 |
.BR BL , |
| 2632 |
but the first line of each paragraph is indented by |
| 2633 |
.BR 5m . |
| 2634 |
.\" XXX: https://savannah.gnu.org/bugs/?64315 |
| 2635 |
T} |
| 2636 |
FB@T{ |
| 2637 |
Fully blocked: |
| 2638 |
everything begins at the left margin. |
| 2639 |
T} |
| 2640 |
SP@T{ |
| 2641 |
Simplified: |
| 2642 |
as |
| 2643 |
.BR FB , |
| 2644 |
but a formal closing is omitted, |
| 2645 |
and the signature is set in full capitals. |
| 2646 |
T} |
| 2647 |
.TE |
| 2648 |
. |
| 2649 |
. |
| 2650 |
.TP |
| 2651 |
.BI MC\~ column-width\~\c |
| 2652 |
.RI [ gutter-width ] |
| 2653 |
Begin multi-column layout. |
| 2654 |
. |
| 2655 |
.I groff mm |
| 2656 |
creates as many columns of |
| 2657 |
.I column-width |
| 2658 |
as the line length will permit. |
| 2659 |
. |
| 2660 |
.I gutter-width |
| 2661 |
is the interior spacing between columns. |
| 2662 |
. |
| 2663 |
It defaults to |
| 2664 |
.IR column-width /15. |
| 2665 |
. |
| 2666 |
.B 1C |
| 2667 |
returns to single-column layout. |
| 2668 |
. |
| 2669 |
.B MC |
| 2670 |
is a GNU extension. |
| 2671 |
. |
| 2672 |
See |
| 2673 |
.B MULB |
| 2674 |
for an alternative. |
| 2675 |
. |
| 2676 |
. |
| 2677 |
.TP |
| 2678 |
.BI ML\~ "mark \fR[\fPtext-indent\~" \fR[\fP1\fR]]\fP |
| 2679 |
Start a list with the |
| 2680 |
.I mark |
| 2681 |
argument preceding each list item. |
| 2682 |
. |
| 2683 |
.I text-indent |
| 2684 |
overrides the default indentation of the list items set by register |
| 2685 |
.BR Li . |
| 2686 |
. |
| 2687 |
If a third argument, |
| 2688 |
conventionally |
| 2689 |
.BR 1 , |
| 2690 |
is given, |
| 2691 |
the blank line that normally precedes each list item is suppressed. |
| 2692 |
. |
| 2693 |
Use |
| 2694 |
.B LI |
| 2695 |
to declare list items, |
| 2696 |
and |
| 2697 |
.B LE |
| 2698 |
to end the list. |
| 2699 |
. |
| 2700 |
. |
| 2701 |
.TP |
| 2702 |
.BR MT \~\c \" space in roman; we must use 2-font macro with \c |
| 2703 |
.RI [ type \~[ addressee ]] |
| 2704 |
Select memorandum type. |
| 2705 |
. |
| 2706 |
These correspond to formats used by AT&T Bell Laboratories, |
| 2707 |
where the |
| 2708 |
.I mm |
| 2709 |
package was initially developed, |
| 2710 |
affecting the document layout. |
| 2711 |
. |
| 2712 |
Some of these included a cover page with a caption categorizing the |
| 2713 |
document. |
| 2714 |
. |
| 2715 |
.I groff mm |
| 2716 |
uses |
| 2717 |
.I type |
| 2718 |
to construct the file name |
| 2719 |
.IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/\:\% type \:.MT |
| 2720 |
and load it with the |
| 2721 |
.B mso |
| 2722 |
request. |
| 2723 |
. |
| 2724 |
Memorandum types 0 to\~5 are supported; |
| 2725 |
any other value of |
| 2726 |
.I type |
| 2727 |
is mapped to type\~6. |
| 2728 |
. |
| 2729 |
If |
| 2730 |
.I type |
| 2731 |
is omitted, |
| 2732 |
.B 0 |
| 2733 |
is implied. |
| 2734 |
. |
| 2735 |
.I addressee |
| 2736 |
sets a string analogous to one used by AT&T cover sheet macros that are |
| 2737 |
not implemented in |
| 2738 |
.IR "groff mm" . |
| 2739 |
. |
| 2740 |
. |
| 2741 |
.IP |
| 2742 |
.TS |
| 2743 |
tab(@); |
| 2744 |
Lf(BI) Lb |
| 2745 |
L L. |
| 2746 |
type@Description |
| 2747 |
0@normal memorandum; no caption |
| 2748 |
1@captioned \[lq]MEMORANDUM FOR FILE\[rq] |
| 2749 |
2@captioned \[lq]PROGRAMMER'S NOTES\[rq] |
| 2750 |
3@captioned \[lq]ENGINEER'S NOTES\[rq] |
| 2751 |
4@released paper |
| 2752 |
5@external letter |
| 2753 |
.TE |
| 2754 |
. |
| 2755 |
. |
| 2756 |
.IP |
| 2757 |
See |
| 2758 |
.B \%COVER |
| 2759 |
for a more flexible cover sheet mechanism. |
| 2760 |
. |
| 2761 |
. |
| 2762 |
.TP |
| 2763 |
.BI MOVE\ "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP" |
| 2764 |
Move to a position, setting page offset to |
| 2765 |
.IR x-pos . |
| 2766 |
. |
| 2767 |
If |
| 2768 |
.I line-length |
| 2769 |
is not given, the difference between current and new page offset is |
| 2770 |
used. |
| 2771 |
. |
| 2772 |
Use |
| 2773 |
.B PGFORM |
| 2774 |
without arguments to return to normal. |
| 2775 |
. |
| 2776 |
. |
| 2777 |
.TP |
| 2778 |
.BR MULB \~\c \" space in roman; we must use 2-font macro with \c |
| 2779 |
.IR "cw1 space1\~" [ "cw2 space2" "] .\|.\|.\~" cwn |
| 2780 |
Begin alternative multi-column mode. |
| 2781 |
. |
| 2782 |
All column widths must be specified, |
| 2783 |
as must the amount of space between each column pair. |
| 2784 |
. |
| 2785 |
The arguments' default scaling unit is |
| 2786 |
.BR n . |
| 2787 |
. |
| 2788 |
.B MULB |
| 2789 |
uses a diversion and operates in a separate environment. |
| 2790 |
. |
| 2791 |
. |
| 2792 |
.TP |
| 2793 |
.B MULN |
| 2794 |
Begin next column in alternative column mode. |
| 2795 |
. |
| 2796 |
. |
| 2797 |
.TP |
| 2798 |
.B MULE |
| 2799 |
End alternative multi-column mode and emit the columns. |
| 2800 |
. |
| 2801 |
. |
| 2802 |
.TP |
| 2803 |
.B NCOL |
| 2804 |
Move to the start of the next column |
| 2805 |
(only when using |
| 2806 |
.B 2C |
| 2807 |
or |
| 2808 |
.BR MC ). |
| 2809 |
. |
| 2810 |
Contrast with |
| 2811 |
.BR MULN . |
| 2812 |
. |
| 2813 |
. |
| 2814 |
.TP |
| 2815 |
.BR ND \~[\c |
| 2816 |
.IR arg ] |
| 2817 |
Set the document's date. |
| 2818 |
. |
| 2819 |
.I mm |
| 2820 |
does not interpret |
| 2821 |
.IR arg ; |
| 2822 |
it can be a revision identifier |
| 2823 |
(or empty). |
| 2824 |
. |
| 2825 |
. |
| 2826 |
.TP |
| 2827 |
.B NE |
| 2828 |
End notation begun with |
| 2829 |
.BR NS ; |
| 2830 |
filling is enabled. |
| 2831 |
. |
| 2832 |
. |
| 2833 |
.TP |
| 2834 |
.BI nP\ \fR[\fPtype\fR]\fP |
| 2835 |
Begin a numbered paragraph at heading level two. |
| 2836 |
. |
| 2837 |
See |
| 2838 |
.BR P . |
| 2839 |
. |
| 2840 |
. |
| 2841 |
.br |
| 2842 |
.ne 6v |
| 2843 |
.TP |
| 2844 |
.BR NS \~[\c |
| 2845 |
.IR code \~[\c |
| 2846 |
.BR 1 ]] |
| 2847 |
Declare notations, |
| 2848 |
typically for letters or memoranda, |
| 2849 |
of the type specified by |
| 2850 |
.IR code . |
| 2851 |
. |
| 2852 |
The text corresponding to |
| 2853 |
.I code |
| 2854 |
is output, |
| 2855 |
and filling is disabled |
| 2856 |
until |
| 2857 |
.B NE |
| 2858 |
is called. |
| 2859 |
. |
| 2860 |
Typically, |
| 2861 |
a list of names or attachments lies within |
| 2862 |
.BR NS / NE . |
| 2863 |
. |
| 2864 |
If |
| 2865 |
.I code |
| 2866 |
is absent or does not match one of the values listed under the |
| 2867 |
.B Letns |
| 2868 |
string description below, |
| 2869 |
each line of notations is formatted as |
| 2870 |
.RI "\[lq]Copy (" line ") to\[rq]." |
| 2871 |
. |
| 2872 |
If a second argument, |
| 2873 |
conventionally |
| 2874 |
.BR 1 , |
| 2875 |
is given, |
| 2876 |
.I code |
| 2877 |
becomes the entire notation and |
| 2878 |
.B NE |
| 2879 |
is not necessary. |
| 2880 |
. |
| 2881 |
In |
| 2882 |
.IR "groff mm" , |
| 2883 |
you can set up further notations to be recognized by |
| 2884 |
.BR NS ; |
| 2885 |
see the strings |
| 2886 |
.B Letns |
| 2887 |
and |
| 2888 |
.B Letnsdef |
| 2889 |
below. |
| 2890 |
. |
| 2891 |
. |
| 2892 |
.TP |
| 2893 |
.BR OF\~ [ \[dq]\|\[aq]\c |
| 2894 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 2895 |
] |
| 2896 |
Define the odd-page footer, |
| 2897 |
which is formatted just above the normal page footer on odd-numbered |
| 2898 |
pages. |
| 2899 |
. |
| 2900 |
See |
| 2901 |
.BR PF . |
| 2902 |
. |
| 2903 |
.B OF |
| 2904 |
defines the string |
| 2905 |
.BR EOPof . |
| 2906 |
. |
| 2907 |
. |
| 2908 |
.TP |
| 2909 |
.BR OH\~ [ \[dq]\|\[aq]\c |
| 2910 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 2911 |
] |
| 2912 |
Define the odd-page header, |
| 2913 |
which is formatted just below the normal page header on odd-numbered |
| 2914 |
pages. |
| 2915 |
. |
| 2916 |
See |
| 2917 |
.BR PH . |
| 2918 |
. |
| 2919 |
.B OH |
| 2920 |
defines the string |
| 2921 |
.BR TPoh . |
| 2922 |
. |
| 2923 |
. |
| 2924 |
.TP |
| 2925 |
.B OP |
| 2926 |
Make sure that the following text is printed at the top of an |
| 2927 |
odd-numbered page. |
| 2928 |
. |
| 2929 |
Does not output an empty page if currently at the top of an odd page. |
| 2930 |
. |
| 2931 |
. |
| 2932 |
.br |
| 2933 |
.ne 4v |
| 2934 |
.TP |
| 2935 |
.BR P \~[\c |
| 2936 |
.IR type ] |
| 2937 |
Begin new paragraph. |
| 2938 |
. |
| 2939 |
If |
| 2940 |
.I type |
| 2941 |
is missing or\~ 0, |
| 2942 |
.BR P \~sets |
| 2943 |
the paragraph fully left\-aligned. |
| 2944 |
. |
| 2945 |
A |
| 2946 |
.I type |
| 2947 |
of\~1 |
| 2948 |
idents the first line by |
| 2949 |
.B \[rs][Pi] |
| 2950 |
ens. |
| 2951 |
. |
| 2952 |
Set the register |
| 2953 |
.B Pt |
| 2954 |
to select a default paragraph indentation style. |
| 2955 |
. |
| 2956 |
The register |
| 2957 |
.B Ps |
| 2958 |
controls the vertical spacing between paragraphs. |
| 2959 |
. |
| 2960 |
. |
| 2961 |
.TP |
| 2962 |
.B PE |
| 2963 |
Picture end; |
| 2964 |
see |
| 2965 |
.MR \%pic 1 . |
| 2966 |
. |
| 2967 |
. |
| 2968 |
.TP |
| 2969 |
.BR PF\~ [ \[dq]\|\[aq]\c |
| 2970 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 2971 |
] |
| 2972 |
Define the page footer. |
| 2973 |
. |
| 2974 |
The footer is formatted at the bottom of each page; |
| 2975 |
the argument is otherwise as described in |
| 2976 |
.BR PH . |
| 2977 |
. |
| 2978 |
.B PF |
| 2979 |
defines the string |
| 2980 |
.BR EOPf . |
| 2981 |
. |
| 2982 |
See |
| 2983 |
.BR EF , |
| 2984 |
.BR OF , |
| 2985 |
and |
| 2986 |
.BR EOP . |
| 2987 |
. |
| 2988 |
.TP |
| 2989 |
.BI PGFORM\ "\fR[\fPlinelength \fR[\fPpagelength \fR[\fPpageoffset\ " \fR[\fP1\fR]]]]\fP |
| 2990 |
Set line length, page length, and/or page offset. |
| 2991 |
. |
| 2992 |
This macro can be used for letterheads and similar. |
| 2993 |
. |
| 2994 |
It is normally the first macro call in a file, |
| 2995 |
though it is not necessary. |
| 2996 |
. |
| 2997 |
.B PGFORM |
| 2998 |
can be used without arguments to reset everything after a |
| 2999 |
.B MOVE |
| 3000 |
call. |
| 3001 |
. |
| 3002 |
A line break is done unless the fourth argument is given. |
| 3003 |
. |
| 3004 |
This can be used to avoid the page number on the first page |
| 3005 |
while setting new width and length. |
| 3006 |
. |
| 3007 |
(It seems as if this macro sometimes doesn't work too well. |
| 3008 |
. |
| 3009 |
Use the command-line arguments to change |
| 3010 |
line length, page length, and page offset instead.) |
| 3011 |
. |
| 3012 |
.TP |
| 3013 |
.B PGNH |
| 3014 |
Suppress header on the next page. |
| 3015 |
. |
| 3016 |
This macro must be called before any macros that produce output to |
| 3017 |
affect the layout of the first page. |
| 3018 |
. |
| 3019 |
. |
| 3020 |
.TP |
| 3021 |
.BR PH\~ [ \[dq]\|\[aq]\c |
| 3022 |
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c |
| 3023 |
] |
| 3024 |
.RS |
| 3025 |
Define the page header, |
| 3026 |
formatted at the top of each page, |
| 3027 |
as the argument, |
| 3028 |
where |
| 3029 |
.IR left , |
| 3030 |
.IR center , |
| 3031 |
and |
| 3032 |
.I right |
| 3033 |
are aligned to the respective locations on the line. |
| 3034 |
. |
| 3035 |
A |
| 3036 |
.RB \[lq] % \[rq] |
| 3037 |
character in |
| 3038 |
.I arg |
| 3039 |
is replaced by the page number. |
| 3040 |
. |
| 3041 |
If the argument is absent, |
| 3042 |
no page header is set. |
| 3043 |
. |
| 3044 |
The default page header is |
| 3045 |
. |
| 3046 |
.RS |
| 3047 |
.EX |
| 3048 |
\[dq]\[aq]\[aq]\- % \-\[aq]\[aq]\[dq] |
| 3049 |
.EE |
| 3050 |
.RE |
| 3051 |
. |
| 3052 |
which centers the page number between hyphens and formats nothing at the |
| 3053 |
upper left and right. |
| 3054 |
. |
| 3055 |
Header macros call |
| 3056 |
.B PX |
| 3057 |
(if defined) |
| 3058 |
after formatting the header. |
| 3059 |
. |
| 3060 |
.B PH |
| 3061 |
defines the string |
| 3062 |
.BR TPh . |
| 3063 |
. |
| 3064 |
See |
| 3065 |
.BR EH , |
| 3066 |
.BR OH , |
| 3067 |
and |
| 3068 |
.BR TP . |
| 3069 |
.RE |
| 3070 |
. |
| 3071 |
. |
| 3072 |
.TP |
| 3073 |
.BR PIC \~\c |
| 3074 |
.RB [ \-B ]\~\c |
| 3075 |
.RB [ \-C |\c |
| 3076 |
.BI \-I\~ n\c |
| 3077 |
.RB | \-L \c |
| 3078 |
.RB | \-R ]\~\c |
| 3079 |
.IR file \~[ width \~[ height ]] |
| 3080 |
Include PostScript document |
| 3081 |
.IR file . |
| 3082 |
. |
| 3083 |
The optional |
| 3084 |
.B \-B |
| 3085 |
argument draws a box around the picture. |
| 3086 |
. |
| 3087 |
The optional |
| 3088 |
.BR \-L , |
| 3089 |
.BR \-C , |
| 3090 |
.BR \-R , |
| 3091 |
and |
| 3092 |
.BI \-I\~ n |
| 3093 |
arguments align the picture or indent it by |
| 3094 |
.I n |
| 3095 |
(assuming a scaling unit of |
| 3096 |
.BR m ). |
| 3097 |
. |
| 3098 |
By default, |
| 3099 |
the picture is left-aligned. |
| 3100 |
. |
| 3101 |
Optional |
| 3102 |
.I width |
| 3103 |
and |
| 3104 |
.I height |
| 3105 |
arguments resize the picture. |
| 3106 |
. |
| 3107 |
Use of this macro requires two-pass processing; |
| 3108 |
see |
| 3109 |
.B INITR |
| 3110 |
and |
| 3111 |
.MR mmroff 1 . |
| 3112 |
. |
| 3113 |
. |
| 3114 |
.TP |
| 3115 |
.B PS |
| 3116 |
Picture start; see |
| 3117 |
.MR \%pic 1 . |
| 3118 |
. |
| 3119 |
. |
| 3120 |
.TP |
| 3121 |
.B PY |
| 3122 |
Picture end with flyback. |
| 3123 |
. |
| 3124 |
Ends a |
| 3125 |
.MR \%pic 1 |
| 3126 |
picture, |
| 3127 |
returning the vertical position to where it was prior to the picture. |
| 3128 |
. |
| 3129 |
This is a GNU extension. |
| 3130 |
. |
| 3131 |
. |
| 3132 |
.TP |
| 3133 |
.BR R \~\c \" space in roman; we must use 2-font macro with \c |
| 3134 |
.RI [ roman-text\~\c |
| 3135 |
.RI [ previous-font-text ]]\~.\|.\|. |
| 3136 |
Join |
| 3137 |
.I roman-text |
| 3138 |
in roman style with |
| 3139 |
.I previous-font-text |
| 3140 |
in the previous font, |
| 3141 |
without space between the arguments. |
| 3142 |
. |
| 3143 |
If no arguments, |
| 3144 |
switch font to roman style. |
| 3145 |
. |
| 3146 |
. |
| 3147 |
.TP |
| 3148 |
.BR RB \~\c \" space in roman; we must use 2-font macro with \c |
| 3149 |
.RI [ roman-text\~\c |
| 3150 |
.RI [ bold-text ]]\~.\|.\|. |
| 3151 |
Join |
| 3152 |
.I roman-text |
| 3153 |
in roman style with |
| 3154 |
.I bold-text |
| 3155 |
in boldface, |
| 3156 |
without space between the arguments. |
| 3157 |
. |
| 3158 |
. |
| 3159 |
.TP |
| 3160 |
.BI RD\ "\fR[\fPprompt \fR[\fPdiversion \fR[\fPstring\fR]]]\fP" |
| 3161 |
Read from standard input to diversion and/or string. |
| 3162 |
. |
| 3163 |
The text is saved in a diversion named |
| 3164 |
.IR diversion . |
| 3165 |
. |
| 3166 |
Recall the text by writing the name of the diversion after a dot |
| 3167 |
on an empty line. |
| 3168 |
. |
| 3169 |
A string is also defined if |
| 3170 |
.I string |
| 3171 |
is given. |
| 3172 |
. |
| 3173 |
.I Diversion |
| 3174 |
and/or |
| 3175 |
.I prompt |
| 3176 |
can be empty (\[dq]\[dq]). |
| 3177 |
. |
| 3178 |
.TP |
| 3179 |
.B RF |
| 3180 |
Reference end. |
| 3181 |
. |
| 3182 |
Ends a reference definition and returns to normal processing. |
| 3183 |
. |
| 3184 |
See |
| 3185 |
.BR RS . |
| 3186 |
. |
| 3187 |
. |
| 3188 |
.TP |
| 3189 |
.BR RI \~\c \" space in roman; we must use 2-font macro with \c |
| 3190 |
.RI [ roman-text\~\c |
| 3191 |
.RI [ italic-text ]]\~.\|.\|. |
| 3192 |
Join |
| 3193 |
.I roman-text |
| 3194 |
in roman style with |
| 3195 |
.I italic-text |
| 3196 |
in italics, |
| 3197 |
without space between the arguments. |
| 3198 |
. |
| 3199 |
. |
| 3200 |
.TP |
| 3201 |
.BR RL \~[\c |
| 3202 |
.IR text-indent \~[\c |
| 3203 |
.BR 1 ]] |
| 3204 |
Begin reference list. |
| 3205 |
. |
| 3206 |
Each item is preceded by an automatically incremented number between |
| 3207 |
square brackets; |
| 3208 |
compare |
| 3209 |
.BR AL . |
| 3210 |
. |
| 3211 |
.I text-indent |
| 3212 |
changes the default indentation. |
| 3213 |
. |
| 3214 |
Use |
| 3215 |
.B LI |
| 3216 |
to declare list items, |
| 3217 |
and |
| 3218 |
.B LE |
| 3219 |
to end the list. |
| 3220 |
. |
| 3221 |
A second argument, |
| 3222 |
conventionally |
| 3223 |
.BR 1 , |
| 3224 |
suppresses the blank line that normally precedes each list item. |
| 3225 |
. |
| 3226 |
. |
| 3227 |
.TP |
| 3228 |
.BR RP \~\c \" space in roman; we must use 2-font macro with \c |
| 3229 |
.RI [ suppress-counter-reset \~[ page-ejection-policy ]] |
| 3230 |
Format a reference page, |
| 3231 |
listing items accumulated within |
| 3232 |
.BR RS / RF |
| 3233 |
pairs. |
| 3234 |
. |
| 3235 |
The reference counter is reset unless the first argument |
| 3236 |
.RB is\~ 1 . |
| 3237 |
. |
| 3238 |
Normally, |
| 3239 |
page breaks occur before and after the references are output; |
| 3240 |
the register |
| 3241 |
.B Rpe |
| 3242 |
configures this behavior, |
| 3243 |
and a second argument overrides its value. |
| 3244 |
. |
| 3245 |
.B TC |
| 3246 |
calls |
| 3247 |
.B RP |
| 3248 |
automatically if references have accumulated. |
| 3249 |
. |
| 3250 |
. |
| 3251 |
.IP |
| 3252 |
References are list items, |
| 3253 |
and thus are vertically separated |
| 3254 |
(see |
| 3255 |
.BR LB ). |
| 3256 |
. |
| 3257 |
Setting register |
| 3258 |
.B Ls |
| 3259 |
.RB to\~ 0 |
| 3260 |
suppresses this spacing. |
| 3261 |
. |
| 3262 |
The string |
| 3263 |
.B Rp |
| 3264 |
contains the reference page caption. |
| 3265 |
. |
| 3266 |
. |
| 3267 |
.br |
| 3268 |
.ne 5v |
| 3269 |
.TP |
| 3270 |
.BR RS \~[\c |
| 3271 |
.IR reference-string ] |
| 3272 |
Begin an automatically numbered reference definition. |
| 3273 |
. |
| 3274 |
By default, |
| 3275 |
references are numbered starting at 1; |
| 3276 |
the number is available in register |
| 3277 |
.BR :R . |
| 3278 |
. |
| 3279 |
Interpolate the string |
| 3280 |
.B Rf |
| 3281 |
where the reference mark should be and write the reference between |
| 3282 |
.BR RS / RF |
| 3283 |
on an input line after the reference mark. |
| 3284 |
. |
| 3285 |
If |
| 3286 |
.I reference-string |
| 3287 |
is specified, |
| 3288 |
.I "groff ms" |
| 3289 |
also stores the reference mark in a string of that name, |
| 3290 |
which can be interpolated as |
| 3291 |
.BI \[rs]*[ reference-string ] |
| 3292 |
subsequently. |
| 3293 |
. |
| 3294 |
. |
| 3295 |
.TP |
| 3296 |
.BR S \~[\c |
| 3297 |
.IR type-size \~[ vertical-spacing ]] |
| 3298 |
Set type size and vertical spacing. |
| 3299 |
. |
| 3300 |
Each argument is a |
| 3301 |
.I groff |
| 3302 |
measurement, |
| 3303 |
using an appropriate scaling unit and an optional |
| 3304 |
.B + |
| 3305 |
or |
| 3306 |
.B \- |
| 3307 |
prefix to increment or decrement the current value. |
| 3308 |
. |
| 3309 |
An argument of |
| 3310 |
.B P |
| 3311 |
restores the previous value, |
| 3312 |
.B C |
| 3313 |
indicates the current value, |
| 3314 |
and |
| 3315 |
.B D |
| 3316 |
requests the default. |
| 3317 |
. |
| 3318 |
An empty or omitted argument is treated as |
| 3319 |
.BR P . |
| 3320 |
. |
| 3321 |
. |
| 3322 |
.TP |
| 3323 |
.BR SA \~\c |
| 3324 |
.RI [ mode ] |
| 3325 |
Set or restore the default enablement of adjustment. |
| 3326 |
. |
| 3327 |
Specify |
| 3328 |
.B 0 |
| 3329 |
or |
| 3330 |
.B 1 |
| 3331 |
as |
| 3332 |
.I mode |
| 3333 |
to set a document's default explicitly; |
| 3334 |
.B 1 |
| 3335 |
is assumed by |
| 3336 |
.IR mm . |
| 3337 |
. |
| 3338 |
Adjustment can be temporarily suspended with the |
| 3339 |
.B na |
| 3340 |
request. |
| 3341 |
. |
| 3342 |
When the |
| 3343 |
.B H |
| 3344 |
or |
| 3345 |
.B HU |
| 3346 |
macros are used to format a heading, |
| 3347 |
or when |
| 3348 |
.B SA |
| 3349 |
is called without a |
| 3350 |
.I mode |
| 3351 |
argument, |
| 3352 |
the default adjustment is restored. |
| 3353 |
. |
| 3354 |
. |
| 3355 |
.TP |
| 3356 |
.BI SETR\ "refname \fR[\fPstring\fR]\fP" |
| 3357 |
Remember the current heading and page numbers as |
| 3358 |
.IR refname . |
| 3359 |
. |
| 3360 |
Saves |
| 3361 |
.I string |
| 3362 |
if |
| 3363 |
.I string |
| 3364 |
is defined. |
| 3365 |
. |
| 3366 |
.I string |
| 3367 |
is retrieved with |
| 3368 |
.BR GETST . |
| 3369 |
. |
| 3370 |
See |
| 3371 |
.BR INITR . |
| 3372 |
. |
| 3373 |
.TP |
| 3374 |
.BI SG\ \fR[\fParg\ \fR[\fP1\fR]]\fP |
| 3375 |
Signature line. |
| 3376 |
. |
| 3377 |
Prints the authors name(s) after the formal closing. |
| 3378 |
. |
| 3379 |
The argument is appended to the reference data, printed at either the |
| 3380 |
first or last author. |
| 3381 |
. |
| 3382 |
The reference data is the location, department, and initials specified |
| 3383 |
with |
| 3384 |
.BR AU . |
| 3385 |
. |
| 3386 |
It is printed at the first author if the second argument is given, |
| 3387 |
otherwise at the last. |
| 3388 |
. |
| 3389 |
No reference data is printed if the author(s) is specified through |
| 3390 |
.BR WA / WE . |
| 3391 |
. |
| 3392 |
See section \[lq]Internals\[rq] below. |
| 3393 |
. |
| 3394 |
. |
| 3395 |
.TP |
| 3396 |
.BR SK \~\c |
| 3397 |
.RI [ n ] |
| 3398 |
Skip |
| 3399 |
.I n |
| 3400 |
pages. |
| 3401 |
. |
| 3402 |
If |
| 3403 |
.I n |
| 3404 |
is\~0 or omitted, |
| 3405 |
the page is broken unless the drawing position is already at the top of |
| 3406 |
a page. |
| 3407 |
. |
| 3408 |
Otherwise, |
| 3409 |
.I n |
| 3410 |
pages, |
| 3411 |
blank except for any headers and footers, |
| 3412 |
are printed. |
| 3413 |
. |
| 3414 |
. |
| 3415 |
.br |
| 3416 |
.ne 4v \" XXX: 3v should suffice |
| 3417 |
.TP |
| 3418 |
.BI SM\~ text\~\c |
| 3419 |
.RI [ post ] |
| 3420 |
.TQ |
| 3421 |
.BI SM\~ "pre text post" |
| 3422 |
Format |
| 3423 |
.I text |
| 3424 |
at a smaller type size, |
| 3425 |
joined with any specified |
| 3426 |
.I pre |
| 3427 |
and |
| 3428 |
.I post |
| 3429 |
at normal size. |
| 3430 |
. |
| 3431 |
. |
| 3432 |
.TP |
| 3433 |
.BI SP\ \fR[\fPlines\fR]\fP |
| 3434 |
Space vertically. |
| 3435 |
. |
| 3436 |
.I lines |
| 3437 |
can have any scaling factor, |
| 3438 |
like \[lq]3i\[rq] or \[lq]8v\[rq]. |
| 3439 |
. |
| 3440 |
Several |
| 3441 |
.B SP |
| 3442 |
calls in a line only produces the maximum number of lines, not the sum. |
| 3443 |
. |
| 3444 |
.B SP |
| 3445 |
is ignored also until the first text line in a page. |
| 3446 |
. |
| 3447 |
Add |
| 3448 |
.B \[rs]& |
| 3449 |
before a call to |
| 3450 |
.B SP |
| 3451 |
to avoid this. |
| 3452 |
. |
| 3453 |
. |
| 3454 |
.TP |
| 3455 |
.B TAB |
| 3456 |
Reset tab stops to every 5\~ens. |
| 3457 |
. |
| 3458 |
. |
| 3459 |
.br |
| 3460 |
.ne 4v |
| 3461 |
.TP |
| 3462 |
.BR TB \~\c |
| 3463 |
.RI [ title \~[ override \~[ flag \~[ refname ]]]] |
| 3464 |
Caption a table. |
| 3465 |
. |
| 3466 |
Arguments are handled analogously to |
| 3467 |
.BR EC . |
| 3468 |
. |
| 3469 |
The register |
| 3470 |
.B Tb |
| 3471 |
is the table counter. |
| 3472 |
. |
| 3473 |
The string |
| 3474 |
.B Litb |
| 3475 |
precedes the table number and any |
| 3476 |
.I title. |
| 3477 |
. |
| 3478 |
Table captions are centered irrespective of the alignment of any |
| 3479 |
enclosing display. |
| 3480 |
. |
| 3481 |
. |
| 3482 |
.IP |
| 3483 |
Captioned tables are listed in a table of contents |
| 3484 |
(see |
| 3485 |
.BR TC ) |
| 3486 |
if the Boolean register |
| 3487 |
.B Lt |
| 3488 |
is true. |
| 3489 |
. |
| 3490 |
Such a list uses the string |
| 3491 |
.B Lt |
| 3492 |
as a heading. |
| 3493 |
. |
| 3494 |
. |
| 3495 |
.TP |
| 3496 |
.BR TC \~\c |
| 3497 |
.RI [ slevel\~\c |
| 3498 |
.RI [ spacing\~\c |
| 3499 |
.RI [ tlevel\~\c |
| 3500 |
.RI [ tab\~\c |
| 3501 |
.RI [ h1\~\c |
| 3502 |
.RI [ h2\~\c |
| 3503 |
.RI [ h3\~\c |
| 3504 |
.RI [ h4\~\c |
| 3505 |
.RI [ h5 ]]]]]]]]] |
| 3506 |
Output table of contents. |
| 3507 |
. |
| 3508 |
This macro is normally the last called in the document. |
| 3509 |
. |
| 3510 |
It flushes any pending displays and, |
| 3511 |
if any references are pending |
| 3512 |
(see |
| 3513 |
.BR RS ), |
| 3514 |
calls |
| 3515 |
.BR RP . |
| 3516 |
. |
| 3517 |
It then begins a new page with the contents caption, |
| 3518 |
stored in the string |
| 3519 |
.BR Licon , |
| 3520 |
centered at the top. |
| 3521 |
. |
| 3522 |
The entries follow after three vees of space. |
| 3523 |
. |
| 3524 |
Each entry is a |
| 3525 |
saved section |
| 3526 |
(number and) |
| 3527 |
heading title |
| 3528 |
(see the |
| 3529 |
.B Cl |
| 3530 |
register), |
| 3531 |
along with its associated page number. |
| 3532 |
. |
| 3533 |
By default, |
| 3534 |
an entry is indented by an amount corresponding to its heading level |
| 3535 |
and the maximum heading length encountered at that heading level; |
| 3536 |
if defined, |
| 3537 |
the string |
| 3538 |
.B Ci |
| 3539 |
overrides these indentations. |
| 3540 |
. |
| 3541 |
Entries at heading levels up to and including |
| 3542 |
.I slevel |
| 3543 |
are preceded by |
| 3544 |
.I spacing |
| 3545 |
vees of space. |
| 3546 |
. |
| 3547 |
Entries at heading levels up to and including |
| 3548 |
.I tlevel |
| 3549 |
are followed by a leader and a right-aligned page number. |
| 3550 |
. |
| 3551 |
If the Boolean-valued |
| 3552 |
.I tab |
| 3553 |
argument is true, |
| 3554 |
the leader is replaced with horizontal motion in the same amount. |
| 3555 |
. |
| 3556 |
For entries above heading level |
| 3557 |
.IR tlevel , |
| 3558 |
the page number follows the heading text after a word space. |
| 3559 |
. |
| 3560 |
Each argument |
| 3561 |
.IR h1 .\|.\|. h5 |
| 3562 |
appears in order on its own line, |
| 3563 |
centered, |
| 3564 |
above the contents caption. |
| 3565 |
. |
| 3566 |
Page numbering restarts at 1, |
| 3567 |
in register format \[lq]i\[rq]. |
| 3568 |
. |
| 3569 |
If the |
| 3570 |
.B Oc |
| 3571 |
register is true, |
| 3572 |
numbering of these pages is suppressed. |
| 3573 |
. |
| 3574 |
. |
| 3575 |
.IP |
| 3576 |
If |
| 3577 |
.B TC |
| 3578 |
is called with at most four arguments, |
| 3579 |
it calls the user-defined macro |
| 3580 |
.B TX |
| 3581 |
(if defined) |
| 3582 |
prior to formatting the contents caption, |
| 3583 |
and |
| 3584 |
.B TY |
| 3585 |
(if defined) |
| 3586 |
.I instead |
| 3587 |
of formatting the contents caption. |
| 3588 |
. |
| 3589 |
. |
| 3590 |
.IP |
| 3591 |
Analogous handling of lists of figures, |
| 3592 |
tables, |
| 3593 |
equations, |
| 3594 |
and exhibits is achieved by defining |
| 3595 |
.BI TX xx |
| 3596 |
and |
| 3597 |
.BI TY xx |
| 3598 |
macros, |
| 3599 |
where |
| 3600 |
.I xx |
| 3601 |
is \[lq]FG\[rq], |
| 3602 |
\[lq]TB\[rq], |
| 3603 |
\[lq]EC\[rq], |
| 3604 |
or \[lq]EX\[rq], |
| 3605 |
respectively. |
| 3606 |
. |
| 3607 |
Similarly, |
| 3608 |
the strings |
| 3609 |
.BR Lifg , |
| 3610 |
.BR Litb , |
| 3611 |
.BR Liex , |
| 3612 |
and |
| 3613 |
.B Liec |
| 3614 |
determine captions for their respective lists. |
| 3615 |
. |
| 3616 |
. |
| 3617 |
.TP |
| 3618 |
.B TE |
| 3619 |
Table end. |
| 3620 |
. |
| 3621 |
See |
| 3622 |
.BR TS . |
| 3623 |
. |
| 3624 |
.TP |
| 3625 |
.B TH |
| 3626 |
End table heading. |
| 3627 |
. |
| 3628 |
It is repeated after page breaks within a table. |
| 3629 |
. |
| 3630 |
See |
| 3631 |
.BR TS . |
| 3632 |
. |
| 3633 |
The |
| 3634 |
.B N |
| 3635 |
argument supported by DWB |
| 3636 |
.I mm |
| 3637 |
is not implemented by |
| 3638 |
.I "groff mm." |
| 3639 |
. |
| 3640 |
. |
| 3641 |
.TP |
| 3642 |
.BR TL \~[\c |
| 3643 |
.IR charging-case-number \~[\c |
| 3644 |
.IR filing-case-number ]] |
| 3645 |
Begin document title. |
| 3646 |
. |
| 3647 |
Input is collected into the title until |
| 3648 |
.B AF |
| 3649 |
or |
| 3650 |
.B AU |
| 3651 |
is called, |
| 3652 |
and output as directed by the cover page. |
| 3653 |
. |
| 3654 |
.I charging-case-number |
| 3655 |
and |
| 3656 |
.I filing-case-number |
| 3657 |
are saved for use in memorandum types 0 and 5. |
| 3658 |
. |
| 3659 |
See |
| 3660 |
.BR MT . |
| 3661 |
. |
| 3662 |
. |
| 3663 |
.TP |
| 3664 |
.BI TM\~ number\c |
| 3665 |
\~.\|.\|. |
| 3666 |
Declare technical memorandum number(s) used by |
| 3667 |
.BR MT . |
| 3668 |
. |
| 3669 |
. |
| 3670 |
.br |
| 3671 |
.ne 6v |
| 3672 |
.TP |
| 3673 |
.B TP |
| 3674 |
If defined, |
| 3675 |
this macro is called in lieu of normal page header layout. |
| 3676 |
. |
| 3677 |
Headers and footers are formatted in a separate environment. |
| 3678 |
. |
| 3679 |
See |
| 3680 |
.BR EOP . |
| 3681 |
. |
| 3682 |
. |
| 3683 |
.IP |
| 3684 |
.TS |
| 3685 |
tab(@); |
| 3686 |
Cb S |
| 3687 |
Lb L. |
| 3688 |
Strings available to TP |
| 3689 |
_ |
| 3690 |
TPh@argument to \fBPH\fP |
| 3691 |
TPeh@argument to \fBEH\fP |
| 3692 |
TPoh@argument to \fBOH\fP |
| 3693 |
.TE |
| 3694 |
. |
| 3695 |
. |
| 3696 |
.TP |
| 3697 |
.B TS \fR[\fPH\fR]\fP |
| 3698 |
Table start. |
| 3699 |
. |
| 3700 |
Argument \[lq]H\[rq] tells |
| 3701 |
.I mm |
| 3702 |
that the table has a heading. |
| 3703 |
. |
| 3704 |
See |
| 3705 |
.BR TE , |
| 3706 |
.BR TH , |
| 3707 |
and |
| 3708 |
.MR \%tbl 1 . |
| 3709 |
. |
| 3710 |
. |
| 3711 |
.TP |
| 3712 |
.BR VERBON \~\c \" space in roman; we must use 2-font macro with \c |
| 3713 |
.RI [ format \~[ type-size \~[ font ]]] |
| 3714 |
Begin verbatim display, |
| 3715 |
where characters have equal width. |
| 3716 |
. |
| 3717 |
.I format |
| 3718 |
controls several parameters. |
| 3719 |
. |
| 3720 |
Add up the values of desired features; |
| 3721 |
the default |
| 3722 |
.RB is\~ 0 . |
| 3723 |
. |
| 3724 |
On typesetting devices, |
| 3725 |
further arguments configure the |
| 3726 |
.I type-size |
| 3727 |
in scaled points, |
| 3728 |
and the face |
| 3729 |
.RI ( font ); |
| 3730 |
the default is |
| 3731 |
.B CR |
| 3732 |
(Courier roman). |
| 3733 |
. |
| 3734 |
. |
| 3735 |
.IP |
| 3736 |
.TS |
| 3737 |
tab(@); |
| 3738 |
lb lb |
| 3739 |
l lx. |
| 3740 |
Value@Effect |
| 3741 |
1@Disable the formatter's escape character (\[rs]). |
| 3742 |
2@Vertically space before the display. |
| 3743 |
4@Vertically space after the display. |
| 3744 |
8@T{ |
| 3745 |
Number output lines; call formatter's |
| 3746 |
.B nm |
| 3747 |
request with arguments in string |
| 3748 |
.BR Verbnm . |
| 3749 |
T} |
| 3750 |
16@T{ |
| 3751 |
Indent by the amount stored in register |
| 3752 |
.BR Verbin . |
| 3753 |
T} |
| 3754 |
.TE |
| 3755 |
. |
| 3756 |
. |
| 3757 |
.TP |
| 3758 |
.B VERBOFF |
| 3759 |
End verbatim display. |
| 3760 |
. |
| 3761 |
. |
| 3762 |
.TP |
| 3763 |
.BR VL \~[\c |
| 3764 |
.IR text-indent \~[ mark-indent \~[\c |
| 3765 |
.BR 1 ]]] |
| 3766 |
Begin variable-item |
| 3767 |
(or \[lq]tagged\[rq]) |
| 3768 |
list. |
| 3769 |
. |
| 3770 |
Each item should supply its own mark, |
| 3771 |
or tag. |
| 3772 |
. |
| 3773 |
If the mark is wider than |
| 3774 |
.I mark-indent, |
| 3775 |
one space separates it from subsequent text; |
| 3776 |
contrast |
| 3777 |
.BR BVL . |
| 3778 |
. |
| 3779 |
.I text-indent |
| 3780 |
sets the indentation of the text, |
| 3781 |
and |
| 3782 |
.I mark-indent |
| 3783 |
the distance from the current list indentation to the mark. |
| 3784 |
. |
| 3785 |
A third argument suppresses the blank line that normally precedes each |
| 3786 |
list item. |
| 3787 |
. |
| 3788 |
Use |
| 3789 |
.B LI |
| 3790 |
to declare list items, |
| 3791 |
and |
| 3792 |
.B LE |
| 3793 |
to end the list. |
| 3794 |
. |
| 3795 |
. |
| 3796 |
.TP |
| 3797 |
.BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP" |
| 3798 |
Vertical margin. |
| 3799 |
. |
| 3800 |
Increase the top and bottom margin by |
| 3801 |
.I top |
| 3802 |
and |
| 3803 |
.IR bottom , |
| 3804 |
respectively. |
| 3805 |
. |
| 3806 |
If option |
| 3807 |
.B \-T |
| 3808 |
is specified, set those margins to |
| 3809 |
.I top |
| 3810 |
and |
| 3811 |
.IR bottom . |
| 3812 |
. |
| 3813 |
If no argument is given, reset the margin to zero, or to the default |
| 3814 |
(\[lq]7v 5v\[rq]) |
| 3815 |
if |
| 3816 |
.B \-T |
| 3817 |
is used. |
| 3818 |
. |
| 3819 |
It is highly recommended that macros |
| 3820 |
.B TP |
| 3821 |
and/or |
| 3822 |
.B EOP |
| 3823 |
are defined if using |
| 3824 |
.B \-T |
| 3825 |
and setting top and/or bottom margin to less than the default. |
| 3826 |
. |
| 3827 |
This undocumented DWB |
| 3828 |
.I mm |
| 3829 |
macro is exposed by |
| 3830 |
.I groff mm |
| 3831 |
to increase user control of page layout. |
| 3832 |
. |
| 3833 |
. |
| 3834 |
.TP |
| 3835 |
.BR WA \~[\c |
| 3836 |
.IR writer's-name \~[\c |
| 3837 |
.IR title ]] |
| 3838 |
Specify the writer(s) of an |
| 3839 |
.B LT |
| 3840 |
letter. |
| 3841 |
. |
| 3842 |
Input is collected into the writer's address until |
| 3843 |
.B WA |
| 3844 |
is called, |
| 3845 |
and then output. |
| 3846 |
. |
| 3847 |
You can specify multiple writers with empty |
| 3848 |
.BR WA / WE |
| 3849 |
pairs; |
| 3850 |
only the last address is used. |
| 3851 |
. |
| 3852 |
The arguments give each writer a name and title. |
| 3853 |
. |
| 3854 |
. |
| 3855 |
.TP |
| 3856 |
.BR WC \~[\c |
| 3857 |
.IR format \~.\|.\|.] |
| 3858 |
Control width of footnotes and displays. |
| 3859 |
. |
| 3860 |
. |
| 3861 |
.IP |
| 3862 |
.RS |
| 3863 |
.TS |
| 3864 |
tab(@); |
| 3865 |
Lf(BI) Lb |
| 3866 |
Lb Lx. |
| 3867 |
format@Effect |
| 3868 |
N@T{ |
| 3869 |
equivalent to |
| 3870 |
.RB \[lq] "\-WF \-FF \-WD" \[rq] |
| 3871 |
.\" FB \" XXX: see Savannah ticket reference below |
| 3872 |
(default) |
| 3873 |
T} |
| 3874 |
WF@T{ |
| 3875 |
set footnotes at full line length, |
| 3876 |
even in two-column mode |
| 3877 |
.\" XXX: what about multi-column modes more generally? |
| 3878 |
T} |
| 3879 |
\-WF@T{ |
| 3880 |
set footnotes using column line length |
| 3881 |
T} |
| 3882 |
FF@T{ |
| 3883 |
apply width of first footnote to encountered to subsequent ones |
| 3884 |
T} |
| 3885 |
\-FF@T{ |
| 3886 |
footnote width determined by |
| 3887 |
.B WF |
| 3888 |
and |
| 3889 |
.B \-WF |
| 3890 |
T} |
| 3891 |
WD@T{ |
| 3892 |
set displays at full line length, |
| 3893 |
even in two-column mode |
| 3894 |
.\" XXX: what about multi-column modes more generally? |
| 3895 |
T} |
| 3896 |
\-WD@T{ |
| 3897 |
set displays using column line length |
| 3898 |
T} |
| 3899 |
.TE |
| 3900 |
.RE |
| 3901 |
.\" XXX: See <https://savannah.gnu.org/bugs/?64316>. |
| 3902 |
.\"FB@T{ |
| 3903 |
.\"Break when outputting floating displays. |
| 3904 |
.\"T} |
| 3905 |
.\"\-FB@T{ |
| 3906 |
.\"Do not break when outputting floating displays. |
| 3907 |
.\"T} |
| 3908 |
. |
| 3909 |
. |
| 3910 |
.TP |
| 3911 |
.B WE |
| 3912 |
End the writer's address begun with |
| 3913 |
.BR WA . |
| 3914 |
. |
| 3915 |
. |
| 3916 |
.br |
| 3917 |
.ne 4v |
| 3918 |
.\" ==================================================================== |
| 3919 |
.SH Strings |
| 3920 |
.\" ==================================================================== |
| 3921 |
. |
| 3922 |
Many |
| 3923 |
.I mm |
| 3924 |
strings interpolate predefined, |
| 3925 |
localizable text. |
| 3926 |
. |
| 3927 |
These are presented in quotation marks. |
| 3928 |
. |
| 3929 |
. |
| 3930 |
.TP |
| 3931 |
.B App |
| 3932 |
\[lq]APPENDIX\[rq] |
| 3933 |
. |
| 3934 |
. |
| 3935 |
.TP |
| 3936 |
.B Apptxt |
| 3937 |
stores the |
| 3938 |
.I title |
| 3939 |
argument to the last |
| 3940 |
.B APP |
| 3941 |
call. |
| 3942 |
. |
| 3943 |
. |
| 3944 |
.TP |
| 3945 |
.B BU |
| 3946 |
interpolates a bullet |
| 3947 |
(see |
| 3948 |
.BR BL ). |
| 3949 |
. |
| 3950 |
. |
| 3951 |
.TP |
| 3952 |
.B Ci |
| 3953 |
is a list of indentation amounts to use for table of contents heading |
| 3954 |
levels, |
| 3955 |
overriding their automatic computation. |
| 3956 |
. |
| 3957 |
Each word must be a horizontal measurement |
| 3958 |
(like |
| 3959 |
.RB \[lq] 1i \[rq]) |
| 3960 |
and is mapped one-to-one to heading levels 1, |
| 3961 |
2, |
| 3962 |
and so on. |
| 3963 |
. |
| 3964 |
. |
| 3965 |
.TP |
| 3966 |
.B DT |
| 3967 |
The date; |
| 3968 |
set by the |
| 3969 |
.B ND |
| 3970 |
macro |
| 3971 |
(defaults to the date the document is formatted). |
| 3972 |
. |
| 3973 |
The format is the conventional one for the |
| 3974 |
.I groff |
| 3975 |
locale, |
| 3976 |
but see the |
| 3977 |
.B ISODATE |
| 3978 |
macro and |
| 3979 |
.B Iso |
| 3980 |
register. |
| 3981 |
. |
| 3982 |
. |
| 3983 |
.TP |
| 3984 |
.B EM |
| 3985 |
interpolates an em dash. |
| 3986 |
. |
| 3987 |
. |
| 3988 |
.TP |
| 3989 |
.B F |
| 3990 |
interpolates an automatically numbered footnote marker; |
| 3991 |
the number is used by the next |
| 3992 |
.B FS |
| 3993 |
call without an argument. |
| 3994 |
. |
| 3995 |
In |
| 3996 |
.I troff |
| 3997 |
mode, |
| 3998 |
the marker is superscripted; |
| 3999 |
in |
| 4000 |
.I nroff |
| 4001 |
mode, |
| 4002 |
it is surrounded by square brackets. |
| 4003 |
. |
| 4004 |
. |
| 4005 |
.TP |
| 4006 |
.B H1txt |
| 4007 |
Updated by |
| 4008 |
.B .H |
| 4009 |
and |
| 4010 |
.B .HU |
| 4011 |
to the current heading text. |
| 4012 |
. |
| 4013 |
Also updated in table of contents & friends. |
| 4014 |
. |
| 4015 |
. |
| 4016 |
.TP |
| 4017 |
.B HF |
| 4018 |
assigns font identifiers, |
| 4019 |
separated by spaces, |
| 4020 |
to heading levels in one-to-one correspondence. |
| 4021 |
. |
| 4022 |
Each identifier may be a font mounting position, |
| 4023 |
font name, |
| 4024 |
or style name. |
| 4025 |
. |
| 4026 |
Omitted values are assumed to be\~1. |
| 4027 |
. |
| 4028 |
The default is |
| 4029 |
.RB \[lq] "2 2 2 2 2 2 2 2 2 2 2 2 2 2" \[rq], |
| 4030 |
which places all headings in italics. |
| 4031 |
. |
| 4032 |
DWB |
| 4033 |
.IR mm 's |
| 4034 |
default was |
| 4035 |
.RB \[lq] "3 3 2 2 2 2 2" \[rq]. |
| 4036 |
. |
| 4037 |
. |
| 4038 |
.TP |
| 4039 |
.B HP |
| 4040 |
assigns type sizes, |
| 4041 |
separated by spaces, |
| 4042 |
to heading levels in one-to-one correspondence. |
| 4043 |
. |
| 4044 |
Each size is interpreted in scaled points; |
| 4045 |
zero values are translated to |
| 4046 |
.BR 10 . |
| 4047 |
. |
| 4048 |
Omitted values are assumed to be\~0 |
| 4049 |
(and are translated accordingly). |
| 4050 |
. |
| 4051 |
The default is |
| 4052 |
.RB \[lq] "0 0 0 0 0 0 0 0 0 0 0 0 0 0" \[rq]. |
| 4053 |
. |
| 4054 |
. |
| 4055 |
.TP |
| 4056 |
.B Index |
| 4057 |
\[lq]INDEX\[rq] |
| 4058 |
. |
| 4059 |
. |
| 4060 |
.TP |
| 4061 |
.B Le |
| 4062 |
\[lq]LIST OF EQUATIONS\[rq] |
| 4063 |
. |
| 4064 |
. |
| 4065 |
.TP |
| 4066 |
.B Letfc |
| 4067 |
\[lq]Yours very truly,\[rq] |
| 4068 |
(see |
| 4069 |
.BR FC ) |
| 4070 |
. |
| 4071 |
. |
| 4072 |
.TP |
| 4073 |
.B Letapp |
| 4074 |
\[lq]APPROVED:\[rq] |
| 4075 |
(see |
| 4076 |
.BR AV ) |
| 4077 |
. |
| 4078 |
. |
| 4079 |
.TP |
| 4080 |
.B LetAT |
| 4081 |
\[lq]ATTENTION:\[rq] |
| 4082 |
(see |
| 4083 |
.BR LO ) |
| 4084 |
. |
| 4085 |
. |
| 4086 |
.TP |
| 4087 |
.B LetCN |
| 4088 |
\[lq]CONFIDENTIAL\[rq] |
| 4089 |
(see |
| 4090 |
.BR LO ) |
| 4091 |
. |
| 4092 |
. |
| 4093 |
.TP |
| 4094 |
.B Letdate |
| 4095 |
\[lq]Date\[rq] |
| 4096 |
(see |
| 4097 |
.BR AV ) |
| 4098 |
. |
| 4099 |
. |
| 4100 |
.TP |
| 4101 |
.B Letns |
| 4102 |
is a group of strings structuring the notations produced by |
| 4103 |
.BR NS . |
| 4104 |
. |
| 4105 |
If the |
| 4106 |
.I code |
| 4107 |
argument to |
| 4108 |
.B NS |
| 4109 |
has no corresponding string, |
| 4110 |
the notation is included between parentheses, |
| 4111 |
prefixed with |
| 4112 |
.BR Letns!copy , |
| 4113 |
and suffixed with |
| 4114 |
.BR Letns!to . |
| 4115 |
. |
| 4116 |
Observe the spaces after \[lq]Copy\[rq] and before \[lq]to\[rq]. |
| 4117 |
. |
| 4118 |
. |
| 4119 |
.RS |
| 4120 |
.P |
| 4121 |
.TS |
| 4122 |
tab(@); |
| 4123 |
Lb Lb Lb |
| 4124 |
L L L. |
| 4125 |
NS code@String@Contents |
| 4126 |
0@Letns!0@Copy to |
| 4127 |
1@Letns!1@Copy (with att.\&) to |
| 4128 |
2@Letns!2@Copy (without att.\&) to |
| 4129 |
3@Letns!3@Att. |
| 4130 |
4@Letns!4@Atts. |
| 4131 |
5@Letns!5@Enc. |
| 4132 |
6@Letns!6@Encs. |
| 4133 |
7@Letns!7@Under separate cover |
| 4134 |
8@Letns!8@Letter to |
| 4135 |
9@Letns!9@Memorandum to |
| 4136 |
10@Letns!10@Copy (with atts.\&) to |
| 4137 |
11@Letns!11@Copy (without atts.\&) to |
| 4138 |
12@Letns!12@Abstract Only to |
| 4139 |
13@Letns!13@Complete Memorandum to |
| 4140 |
14@Letns!14@CC |
| 4141 |
\[em]@Letns!copy@Copy \fI(with trailing space)\fP |
| 4142 |
\[em]@Letns!to@ to \fI(note leading space)\fP |
| 4143 |
.TE |
| 4144 |
.RE |
| 4145 |
. |
| 4146 |
. |
| 4147 |
.TP |
| 4148 |
.B Letnsdef |
| 4149 |
Select the notation format used by |
| 4150 |
.B NS |
| 4151 |
when it is given no argument. |
| 4152 |
. |
| 4153 |
The default is |
| 4154 |
.RB \[lq] 0 \[rq]. |
| 4155 |
. |
| 4156 |
. |
| 4157 |
.TP |
| 4158 |
.B LetRN |
| 4159 |
\[lq]In reference to:\[rq] |
| 4160 |
(see |
| 4161 |
.BR LO ) |
| 4162 |
. |
| 4163 |
. |
| 4164 |
.TP |
| 4165 |
.B LetSA |
| 4166 |
\[lq]To Whom It May Concern:\[rq] |
| 4167 |
(see |
| 4168 |
.BR LO ) |
| 4169 |
. |
| 4170 |
. |
| 4171 |
.TP |
| 4172 |
.B LetSJ |
| 4173 |
\[lq]SUBJECT:\[rq] |
| 4174 |
(see |
| 4175 |
.BR LO ) |
| 4176 |
. |
| 4177 |
. |
| 4178 |
.TP |
| 4179 |
.B Lf |
| 4180 |
\[lq]LIST OF FIGURES\[rq] |
| 4181 |
. |
| 4182 |
. |
| 4183 |
.TP |
| 4184 |
.B Licon |
| 4185 |
\[lq]CONTENTS\[rq] |
| 4186 |
. |
| 4187 |
. |
| 4188 |
.TP |
| 4189 |
.B Liec |
| 4190 |
\[lq]Equation\[rq] |
| 4191 |
. |
| 4192 |
. |
| 4193 |
.TP |
| 4194 |
.B Liex |
| 4195 |
\[lq]Exhibit\[rq] |
| 4196 |
. |
| 4197 |
. |
| 4198 |
.TP |
| 4199 |
.B Lifg |
| 4200 |
\[lq]Figure\[rq] |
| 4201 |
. |
| 4202 |
. |
| 4203 |
.TP |
| 4204 |
.B Litb |
| 4205 |
\[lq]TABLE\[rq] |
| 4206 |
. |
| 4207 |
. |
| 4208 |
.TP |
| 4209 |
.B Lt |
| 4210 |
\[lq]LIST OF TABLES\[rq] |
| 4211 |
. |
| 4212 |
. |
| 4213 |
.TP |
| 4214 |
.B Lx |
| 4215 |
\[lq]LIST OF EXHIBITS\[rq] |
| 4216 |
. |
| 4217 |
. |
| 4218 |
.TP |
| 4219 |
.BR MO1 \|.\|.\|.\| MO12 |
| 4220 |
\[lq]January\[rq] through \[lq]December\[rq] |
| 4221 |
. |
| 4222 |
. |
| 4223 |
.TP |
| 4224 |
.B Qrf |
| 4225 |
\[lq]See chapter \[rs]\[rs]*[Qrfh], |
| 4226 |
page \[rs]\[rs]n[Qrfp].\[rq] |
| 4227 |
. |
| 4228 |
. |
| 4229 |
.TP |
| 4230 |
.B Rf |
| 4231 |
interpolates an automatically numbered reference mark; |
| 4232 |
the number is used by the next |
| 4233 |
.B RS |
| 4234 |
call. |
| 4235 |
. |
| 4236 |
In |
| 4237 |
.I troff |
| 4238 |
mode, |
| 4239 |
the marker is superscripted; |
| 4240 |
in |
| 4241 |
.I nroff |
| 4242 |
mode, |
| 4243 |
it is surrounded by square brackets. |
| 4244 |
. |
| 4245 |
. |
| 4246 |
.TP |
| 4247 |
.B Rp |
| 4248 |
\[lq]REFERENCES\[rq] |
| 4249 |
. |
| 4250 |
. |
| 4251 |
. |
| 4252 |
.TP |
| 4253 |
.B Sm |
| 4254 |
interpolates |
| 4255 |
.if c \[u2120] \[u2120], |
| 4256 |
the service mark sign. |
| 4257 |
. |
| 4258 |
. |
| 4259 |
.TP |
| 4260 |
.B Tcst |
| 4261 |
interpolates an indicator of the |
| 4262 |
.B TC |
| 4263 |
macro's processing status. |
| 4264 |
. |
| 4265 |
If |
| 4266 |
.B TC |
| 4267 |
is not operating, |
| 4268 |
it is empty. |
| 4269 |
. |
| 4270 |
User-defined |
| 4271 |
.B TP |
| 4272 |
or |
| 4273 |
.B EOP |
| 4274 |
macros might condition page headers or footers on its contents. |
| 4275 |
. |
| 4276 |
. |
| 4277 |
.IP |
| 4278 |
.TS |
| 4279 |
tab(@); |
| 4280 |
lb lb |
| 4281 |
l l. |
| 4282 |
Value@Meaning |
| 4283 |
co@Table of contents |
| 4284 |
fg@List of figures |
| 4285 |
tb@List of tables |
| 4286 |
ec@List of equations |
| 4287 |
ex@List of exhibits |
| 4288 |
ap@Appendix |
| 4289 |
.TE |
| 4290 |
. |
| 4291 |
. |
| 4292 |
.TP |
| 4293 |
.B Tm |
| 4294 |
interpolates |
| 4295 |
.if c \[tm] \[tm], |
| 4296 |
the trade mark sign. |
| 4297 |
. |
| 4298 |
. |
| 4299 |
.TP |
| 4300 |
.B Verbnm |
| 4301 |
supplies argument(s) to the |
| 4302 |
.B nm |
| 4303 |
request employed by the |
| 4304 |
.B VERBON |
| 4305 |
macro. |
| 4306 |
. |
| 4307 |
The default is\~\[lq]1\[rq]. |
| 4308 |
. |
| 4309 |
. |
| 4310 |
.br |
| 4311 |
.ne 4v |
| 4312 |
.\" ==================================================================== |
| 4313 |
.SH Registers |
| 4314 |
.\" ==================================================================== |
| 4315 |
. |
| 4316 |
Default register values, |
| 4317 |
where meaningful, |
| 4318 |
are shown in parentheses. |
| 4319 |
. |
| 4320 |
Many are also marked as Boolean-valued, |
| 4321 |
meaning that they are considered \[lq]true\[rq] |
| 4322 |
(on, |
| 4323 |
enabled) |
| 4324 |
when they have a positive value, |
| 4325 |
and \[lq]false\[rq] |
| 4326 |
(off, |
| 4327 |
disabled) |
| 4328 |
otherwise. |
| 4329 |
. |
| 4330 |
. |
| 4331 |
.TP |
| 4332 |
.B .mgm |
| 4333 |
indicates that |
| 4334 |
.I groff mm |
| 4335 |
is in use |
| 4336 |
(Boolean-valued; |
| 4337 |
.BR 1 ). |
| 4338 |
. |
| 4339 |
. |
| 4340 |
.TP |
| 4341 |
.B :p |
| 4342 |
is an auto-incrementing footnote counter; |
| 4343 |
see |
| 4344 |
.BR FS . |
| 4345 |
. |
| 4346 |
. |
| 4347 |
.TP |
| 4348 |
.B :R |
| 4349 |
is an auto-incrementing reference counter; |
| 4350 |
see |
| 4351 |
.BR RS . |
| 4352 |
. |
| 4353 |
. |
| 4354 |
.TP |
| 4355 |
.B Aph |
| 4356 |
formats an appendix heading |
| 4357 |
(and title, |
| 4358 |
if supplied); |
| 4359 |
see |
| 4360 |
.B APP |
| 4361 |
(Boolean-valued; |
| 4362 |
.BR 1 ). |
| 4363 |
. |
| 4364 |
. |
| 4365 |
.TP |
| 4366 |
.B Au |
| 4367 |
includes supplemental author information |
| 4368 |
(the third and subsequent arguments to |
| 4369 |
.BR AU ) |
| 4370 |
in memorandum \[lq]from\[rq] information; |
| 4371 |
see |
| 4372 |
.B COVER |
| 4373 |
and |
| 4374 |
.B MT |
| 4375 |
(Boolean-valued; |
| 4376 |
.BR 1 ). |
| 4377 |
. |
| 4378 |
. |
| 4379 |
.TP |
| 4380 |
.B Cl |
| 4381 |
sets the threshold for inclusion of headings in a table of contents. |
| 4382 |
. |
| 4383 |
Headings at levels above this value are excluded; |
| 4384 |
see |
| 4385 |
.B H |
| 4386 |
and |
| 4387 |
.B TC |
| 4388 |
.RB ( 2 ). |
| 4389 |
. |
| 4390 |
The |
| 4391 |
.B Cl |
| 4392 |
register controls whether a heading is |
| 4393 |
.I saved |
| 4394 |
for output in the table of contents at the time |
| 4395 |
.B H |
| 4396 |
or |
| 4397 |
.B HU |
| 4398 |
is called; |
| 4399 |
if you change |
| 4400 |
.BR Cl 's |
| 4401 |
value immediately prior to calling |
| 4402 |
.BR TC , |
| 4403 |
you are unlikely to get the result you want. |
| 4404 |
. |
| 4405 |
. |
| 4406 |
.TP |
| 4407 |
.B Cp |
| 4408 |
suppresses page breaks before lists of captioned |
| 4409 |
equations, |
| 4410 |
exhibits, |
| 4411 |
figures, |
| 4412 |
and tables, |
| 4413 |
and before an index; |
| 4414 |
see |
| 4415 |
.BR EC , |
| 4416 |
.BR EX , |
| 4417 |
.BR FG , |
| 4418 |
.BR TB , |
| 4419 |
and |
| 4420 |
.B INDP |
| 4421 |
(Boolean-valued; |
| 4422 |
.\" DWB 3.3's manual said this was 1, but the code said 0. |
| 4423 |
.BR 0 ). |
| 4424 |
. |
| 4425 |
. |
| 4426 |
.TP |
| 4427 |
.B D |
| 4428 |
produces debugging information for the |
| 4429 |
.I mm |
| 4430 |
package on the standard error stream. |
| 4431 |
. |
| 4432 |
A value of\~0 outputs nothing; |
| 4433 |
1\~reports formatting progress. |
| 4434 |
. |
| 4435 |
Higher values communicate internal state information of increasing |
| 4436 |
verbosity |
| 4437 |
.RB ( 0 ). |
| 4438 |
. |
| 4439 |
. |
| 4440 |
.TP |
| 4441 |
.B De |
| 4442 |
causes a page break after a floating display is output; |
| 4443 |
see |
| 4444 |
.B DF |
| 4445 |
(Boolean-valued; |
| 4446 |
.BR 0 ). |
| 4447 |
. |
| 4448 |
. |
| 4449 |
.TP |
| 4450 |
.B Df |
| 4451 |
configures the behavior of |
| 4452 |
.BR DF . |
| 4453 |
. |
| 4454 |
The following values are recognized; |
| 4455 |
4 and 5 do not override the |
| 4456 |
.B De |
| 4457 |
register |
| 4458 |
.RB ( 5 ). |
| 4459 |
. |
| 4460 |
. |
| 4461 |
.IP |
| 4462 |
.TS |
| 4463 |
tab(@); |
| 4464 |
Lb Lb |
| 4465 |
L Lx. |
| 4466 |
Value@Effect |
| 4467 |
0@T{ |
| 4468 |
Flush pending displays |
| 4469 |
at the end of each section |
| 4470 |
when section-page numbering is active, |
| 4471 |
otherwise at the end of the document. |
| 4472 |
T} |
| 4473 |
1@T{ |
| 4474 |
Flush a pending display |
| 4475 |
on the current page or column |
| 4476 |
if there is enough space, |
| 4477 |
otherwise at the end of the document. |
| 4478 |
T} |
| 4479 |
2@T{ |
| 4480 |
Flush one pending display |
| 4481 |
at the top of each page or column. |
| 4482 |
T} |
| 4483 |
3@T{ |
| 4484 |
Flush a pending display |
| 4485 |
on the current page or column |
| 4486 |
if there is enough space, |
| 4487 |
otherwise at the top of the next. |
| 4488 |
T} |
| 4489 |
4@T{ |
| 4490 |
Flush as many pending displays |
| 4491 |
as possible in a new page or column. |
| 4492 |
T} |
| 4493 |
5@T{ |
| 4494 |
Fill columns or pages with flushed displays |
| 4495 |
until none remain. |
| 4496 |
T} |
| 4497 |
.TE |
| 4498 |
. |
| 4499 |
. |
| 4500 |
.TP |
| 4501 |
.B Ds |
| 4502 |
puts vertical space in the amount of register |
| 4503 |
.B Dsp |
| 4504 |
(if defined) or |
| 4505 |
.B Lsp |
| 4506 |
before and after each static display; |
| 4507 |
see |
| 4508 |
.B DS |
| 4509 |
(Boolean-valued; |
| 4510 |
.BR 1 ). |
| 4511 |
. |
| 4512 |
. |
| 4513 |
.TP |
| 4514 |
.B Dsp |
| 4515 |
configures the amount of vertical space placed |
| 4516 |
before and after static displays; |
| 4517 |
see |
| 4518 |
.B DS |
| 4519 |
and register |
| 4520 |
.B Ds |
| 4521 |
.RI ( undefined ). |
| 4522 |
. |
| 4523 |
. |
| 4524 |
.TP |
| 4525 |
.B Ec |
| 4526 |
is an auto-incrementing equation counter; |
| 4527 |
see |
| 4528 |
.BR EC . |
| 4529 |
. |
| 4530 |
. |
| 4531 |
.TP |
| 4532 |
.B Ej |
| 4533 |
sets the threshold for page breaks (ejection) prior to the format of |
| 4534 |
headings. |
| 4535 |
. |
| 4536 |
Headings at levels above this value are set on the same page and column |
| 4537 |
if possible; |
| 4538 |
see |
| 4539 |
.B H |
| 4540 |
.RB ( 0 ). |
| 4541 |
. |
| 4542 |
. |
| 4543 |
.TP |
| 4544 |
.B Eq |
| 4545 |
aligns an equation label to the left of a display instead of the right |
| 4546 |
(Boolean-valued; |
| 4547 |
.BR 0 ). |
| 4548 |
. |
| 4549 |
. |
| 4550 |
.TP |
| 4551 |
.B Ex |
| 4552 |
is an auto-incrementing exhibit counter; |
| 4553 |
see |
| 4554 |
.BR EX . |
| 4555 |
. |
| 4556 |
. |
| 4557 |
.TP |
| 4558 |
.B Fg |
| 4559 |
is an auto-incrementing figure counter; |
| 4560 |
see |
| 4561 |
.BR FG . |
| 4562 |
. |
| 4563 |
. |
| 4564 |
.TP |
| 4565 |
.B Fs |
| 4566 |
is multiplied by register |
| 4567 |
.B Lsp |
| 4568 |
to vertically separate footnotes; |
| 4569 |
see |
| 4570 |
.B FS |
| 4571 |
.RB ( 1 ). |
| 4572 |
. |
| 4573 |
. |
| 4574 |
.TP |
| 4575 |
.BR H1 \|.\|.\|.\| H14 |
| 4576 |
are auto-incrementing counters corresponding to each heading level; |
| 4577 |
see |
| 4578 |
.BR H . |
| 4579 |
. |
| 4580 |
. |
| 4581 |
.\" XXX: This could be generalized to an "Hdot" threshold register with |
| 4582 |
.\" a default of 2. |
| 4583 |
.TP |
| 4584 |
.B H1dot |
| 4585 |
appends a period to the number of a level one heading; |
| 4586 |
see |
| 4587 |
.B H |
| 4588 |
(Boolean-valued; |
| 4589 |
.BR 1 ). |
| 4590 |
. |
| 4591 |
. |
| 4592 |
.\" XXX: This may be insufficiently general; see Savannah #62825. |
| 4593 |
.TP |
| 4594 |
.B H1h |
| 4595 |
is a copy of |
| 4596 |
A copy of register |
| 4597 |
.RB register\~ H1 , |
| 4598 |
but it is incremented just before a page break. |
| 4599 |
. |
| 4600 |
This can be useful in user-defined macros; |
| 4601 |
see |
| 4602 |
.B H |
| 4603 |
and |
| 4604 |
.BR HX . |
| 4605 |
. |
| 4606 |
. |
| 4607 |
.TP |
| 4608 |
.B Hb |
| 4609 |
sets the threshold for breaking the line after formatting a heading. |
| 4610 |
. |
| 4611 |
Text after headings at levels above this value are set on the same |
| 4612 |
output line if possible; |
| 4613 |
see |
| 4614 |
.B H |
| 4615 |
.RB ( 2 ). |
| 4616 |
. |
| 4617 |
. |
| 4618 |
.TP |
| 4619 |
.B Hc |
| 4620 |
sets the threshold for centering a heading. |
| 4621 |
. |
| 4622 |
Headings at levels above this value use the prevailing alignment |
| 4623 |
(that is, |
| 4624 |
they are not centered); |
| 4625 |
see |
| 4626 |
.B H |
| 4627 |
.RB ( 0 ). |
| 4628 |
. |
| 4629 |
. |
| 4630 |
.TP |
| 4631 |
.B Hi |
| 4632 |
configures the indentation of text after headings. |
| 4633 |
. |
| 4634 |
It does not affect \[lq]run-in\[rq] headings. |
| 4635 |
. |
| 4636 |
The following values are recognized; |
| 4637 |
see |
| 4638 |
.B H |
| 4639 |
and |
| 4640 |
.B P |
| 4641 |
.RB ( 1 ). |
| 4642 |
. |
| 4643 |
. |
| 4644 |
.IP |
| 4645 |
.TS |
| 4646 |
tab(@); |
| 4647 |
Lb Lb |
| 4648 |
L Lx. |
| 4649 |
Value@Effect |
| 4650 |
0@no indentation |
| 4651 |
1@indent per the paragraph type |
| 4652 |
2@indent to align with heading title |
| 4653 |
.TE |
| 4654 |
. |
| 4655 |
. |
| 4656 |
.TP |
| 4657 |
.B Hps |
| 4658 |
sets the heading level threshold for application of preceding vertical |
| 4659 |
space; |
| 4660 |
see |
| 4661 |
.BR H . |
| 4662 |
. |
| 4663 |
Headings at levels above the value in register |
| 4664 |
.B Hps |
| 4665 |
use the amount of space in register |
| 4666 |
.BR Hps1 ; |
| 4667 |
otherwise that in |
| 4668 |
.BR Hps2 . |
| 4669 |
. |
| 4670 |
The value of |
| 4671 |
.B Hps |
| 4672 |
should be strictly greater than that of |
| 4673 |
.B Ej |
| 4674 |
.RB ( 1 ). |
| 4675 |
. |
| 4676 |
. |
| 4677 |
.TP |
| 4678 |
.B Hps1 |
| 4679 |
configures the amount of vertical space preceding a heading above the |
| 4680 |
.B Hps |
| 4681 |
threshold; |
| 4682 |
see |
| 4683 |
.B H |
| 4684 |
.RI ( troff |
| 4685 |
devices: |
| 4686 |
.BR 0.5v ; |
| 4687 |
.I nroff |
| 4688 |
devices: |
| 4689 |
.BR 1v ). |
| 4690 |
. |
| 4691 |
. |
| 4692 |
.TP |
| 4693 |
.B Hps2 |
| 4694 |
configures the amount of vertical space preceding a heading at or below |
| 4695 |
the |
| 4696 |
.B Hps |
| 4697 |
threshold; |
| 4698 |
see |
| 4699 |
.B H |
| 4700 |
.RI ( troff |
| 4701 |
devices: |
| 4702 |
.BR 1v ; |
| 4703 |
.I nroff |
| 4704 |
devices: |
| 4705 |
.BR 2v ). |
| 4706 |
. |
| 4707 |
. |
| 4708 |
.TP |
| 4709 |
.B Hs |
| 4710 |
sets the heading level threshold for application of succeeding vertical |
| 4711 |
space. |
| 4712 |
. |
| 4713 |
If the heading level is greater than |
| 4714 |
.BR Hs , |
| 4715 |
the heading is followed by vertical space in the amount of |
| 4716 |
.RB register\~ Hss ; |
| 4717 |
see |
| 4718 |
.B H |
| 4719 |
.RB ( 2 ). |
| 4720 |
. |
| 4721 |
. |
| 4722 |
.TP |
| 4723 |
.B Hss |
| 4724 |
is multiplied by register |
| 4725 |
.B Lsp |
| 4726 |
to produce vertical space after headings above the |
| 4727 |
threshold in |
| 4728 |
.RB register\~ Hs ; |
| 4729 |
see |
| 4730 |
.B H |
| 4731 |
.RB ( 1 ). |
| 4732 |
. |
| 4733 |
. |
| 4734 |
.TP |
| 4735 |
.B Ht |
| 4736 |
suppresses output of heading level counters above the lowest when the |
| 4737 |
heading is formatted; |
| 4738 |
see |
| 4739 |
.B H |
| 4740 |
(Boolean-valued; |
| 4741 |
.BR 0 ). |
| 4742 |
. |
| 4743 |
. |
| 4744 |
. |
| 4745 |
.TP |
| 4746 |
.B Hu |
| 4747 |
sets the heading level used by unnumbered headings; |
| 4748 |
see |
| 4749 |
.B HU |
| 4750 |
.RB ( 2 ). |
| 4751 |
. |
| 4752 |
. |
| 4753 |
.TP |
| 4754 |
.B Hy |
| 4755 |
enables automatic hyphenation of words |
| 4756 |
(Boolean-valued; |
| 4757 |
.BR 0 ). |
| 4758 |
. |
| 4759 |
. |
| 4760 |
.TP |
| 4761 |
.B Iso |
| 4762 |
configures the use of ISO\~8601 date format |
| 4763 |
if specified |
| 4764 |
(with any value) |
| 4765 |
on the command line; |
| 4766 |
see |
| 4767 |
.BR ISODATE . |
| 4768 |
. |
| 4769 |
The default is determined by localization files. |
| 4770 |
. |
| 4771 |
. |
| 4772 |
.TP |
| 4773 |
.B L |
| 4774 |
defines the page length for the document, |
| 4775 |
and must be set from the command line. |
| 4776 |
. |
| 4777 |
A scaling unit should be appended. |
| 4778 |
. |
| 4779 |
The default is that of the selected |
| 4780 |
.I groff |
| 4781 |
output device. |
| 4782 |
. |
| 4783 |
. |
| 4784 |
.TP |
| 4785 |
.B Le |
| 4786 |
.TQ |
| 4787 |
.B Lf |
| 4788 |
.TQ |
| 4789 |
.B Lt |
| 4790 |
.TQ |
| 4791 |
.B Lx |
| 4792 |
configure the report of lists of equation, |
| 4793 |
figure, |
| 4794 |
table, |
| 4795 |
and exhibit captions, |
| 4796 |
respectively, |
| 4797 |
after a table of contents; |
| 4798 |
see |
| 4799 |
.B TC |
| 4800 |
(Boolean-valued; |
| 4801 |
.BR Le :\~ 0 ; |
| 4802 |
.BR Lf , |
| 4803 |
.BR Lt , |
| 4804 |
.BR Lx :\~ 1 ). |
| 4805 |
. |
| 4806 |
. |
| 4807 |
.\" XXX: What is the rationale for this feature? |
| 4808 |
.TP |
| 4809 |
.B Letwam |
| 4810 |
sets the maximum number of input lines permitted in a writer's address; |
| 4811 |
see |
| 4812 |
.B WA |
| 4813 |
and |
| 4814 |
.B WE |
| 4815 |
.RB ( 14 ). |
| 4816 |
. |
| 4817 |
. |
| 4818 |
.TP |
| 4819 |
.B Li |
| 4820 |
configures the amount of indentation in ens applied to list items; |
| 4821 |
see |
| 4822 |
.B LI |
| 4823 |
.RB ( 6 ). |
| 4824 |
. |
| 4825 |
. |
| 4826 |
.TP |
| 4827 |
.B Limsp |
| 4828 |
inserts a space between the prefix and the mark |
| 4829 |
in automatically numbered lists; |
| 4830 |
see |
| 4831 |
.B AL |
| 4832 |
(Boolean-valued; |
| 4833 |
.BR 1 ). |
| 4834 |
. |
| 4835 |
. |
| 4836 |
.TP |
| 4837 |
.B Ls |
| 4838 |
sets a threshold for placement of vertical space before list items. |
| 4839 |
. |
| 4840 |
If the list nesting level is greater than this value, |
| 4841 |
no such spacing occurs; |
| 4842 |
see |
| 4843 |
.B LI |
| 4844 |
.RB ( 99 ). |
| 4845 |
. |
| 4846 |
. |
| 4847 |
.TP |
| 4848 |
.B Lsp |
| 4849 |
configures the base amount of vertical space used for separation |
| 4850 |
in the document. |
| 4851 |
. |
| 4852 |
.I mm |
| 4853 |
applies this spacing to many contexts, |
| 4854 |
sometimes with multipliers; |
| 4855 |
see |
| 4856 |
.BR DS , |
| 4857 |
.BR FS , |
| 4858 |
.BR H , |
| 4859 |
.BR LI , |
| 4860 |
and |
| 4861 |
.B P |
| 4862 |
.RI ( troff |
| 4863 |
devices: |
| 4864 |
.BR 0.5v ; |
| 4865 |
.I nroff |
| 4866 |
devices: |
| 4867 |
.BR 1v ). |
| 4868 |
. |
| 4869 |
. |
| 4870 |
.TP |
| 4871 |
.B N |
| 4872 |
configures the header and footer placements used by |
| 4873 |
.BR PH . |
| 4874 |
. |
| 4875 |
The default footer is empty. |
| 4876 |
. |
| 4877 |
If \[lq]section-page\[rq] numbering is selected, |
| 4878 |
the default header becomes empty |
| 4879 |
and the default footer becomes |
| 4880 |
.RI \[lq] x - y \[rq], |
| 4881 |
where |
| 4882 |
.IR x \~is |
| 4883 |
is the section number |
| 4884 |
(the number of the current first-level heading) |
| 4885 |
.RI and\~ y |
| 4886 |
the page number within the section. |
| 4887 |
.\" XXX: section-figure numbering needs more documentation. |
| 4888 |
. |
| 4889 |
The following values are recognized; |
| 4890 |
for finer control, |
| 4891 |
see |
| 4892 |
.BR PH , |
| 4893 |
.BR PF , |
| 4894 |
.BR EH , |
| 4895 |
.BR EF , |
| 4896 |
.BR OH , |
| 4897 |
and |
| 4898 |
.BR OF , |
| 4899 |
and registers |
| 4900 |
.B Sectf |
| 4901 |
and |
| 4902 |
.BR Sectp . |
| 4903 |
. |
| 4904 |
Value 5 is a GNU extension |
| 4905 |
.RB ( 0 ). |
| 4906 |
. |
| 4907 |
. |
| 4908 |
.IP |
| 4909 |
.TS |
| 4910 |
tab(@); |
| 4911 |
Lb Lb |
| 4912 |
L Lx. |
| 4913 |
Value@Effect |
| 4914 |
0@Set header on all pages. |
| 4915 |
1@Move header to footer on page 1. |
| 4916 |
2@Omit header on page 1. |
| 4917 |
3@Use \[lq]section-page\[rq] numbering style on all pages. |
| 4918 |
4@Omit header on all pages. |
| 4919 |
5@T{ |
| 4920 |
Use \[lq]section-page\[rq] and \[lq]section-figure\[rq] \ |
| 4921 |
numbering style on all pages. |
| 4922 |
T} |
| 4923 |
.TE |
| 4924 |
. |
| 4925 |
. |
| 4926 |
.TP |
| 4927 |
.B Np |
| 4928 |
causes paragraphs after first-level headings (only) to be numbered |
| 4929 |
in the format |
| 4930 |
.IR s . p , |
| 4931 |
where |
| 4932 |
.IR s \~is |
| 4933 |
is the section number |
| 4934 |
(the number of the current first-level heading) |
| 4935 |
and |
| 4936 |
.IR p \~is |
| 4937 |
the paragraph number, |
| 4938 |
starting at 1; |
| 4939 |
see |
| 4940 |
.B H |
| 4941 |
and |
| 4942 |
.B P |
| 4943 |
(Boolean-valued; |
| 4944 |
.BR 0 ). |
| 4945 |
. |
| 4946 |
. |
| 4947 |
.TP |
| 4948 |
.B O |
| 4949 |
defines the page offset of the document, |
| 4950 |
and must be set from the command line. |
| 4951 |
. |
| 4952 |
A scaling unit should be appended. |
| 4953 |
. |
| 4954 |
The default |
| 4955 |
.RB is\~ \&.75i |
| 4956 |
on terminal devices. |
| 4957 |
. |
| 4958 |
On typesetters, |
| 4959 |
it is |
| 4960 |
.B \&.963i |
| 4961 |
or set to |
| 4962 |
.B 1i |
| 4963 |
by the |
| 4964 |
.I papersize.tmac |
| 4965 |
package; |
| 4966 |
see |
| 4967 |
.MR groff_tmac 5 . |
| 4968 |
. |
| 4969 |
. |
| 4970 |
.TP |
| 4971 |
.B Oc |
| 4972 |
suppresses the appearance of page numbers in the table of contents; |
| 4973 |
see |
| 4974 |
.B TC |
| 4975 |
(Boolean-valued; |
| 4976 |
.BR 0 ). |
| 4977 |
. |
| 4978 |
. |
| 4979 |
.\" XXX: This really should just be a string, shouldn't it? |
| 4980 |
.TP |
| 4981 |
.B Of |
| 4982 |
selects a separator format within equation, |
| 4983 |
exhibit, |
| 4984 |
figure, |
| 4985 |
and table captions; |
| 4986 |
see |
| 4987 |
.BR EC , |
| 4988 |
.BR EX , |
| 4989 |
.BR FG , |
| 4990 |
and |
| 4991 |
.BR TB . |
| 4992 |
. |
| 4993 |
The following values are recognized; |
| 4994 |
the spaces shown are unpaddable |
| 4995 |
.RB ( 0 ). |
| 4996 |
. |
| 4997 |
. |
| 4998 |
.IP |
| 4999 |
.TS |
| 5000 |
tab(@); |
| 5001 |
Lb Lb |
| 5002 |
L Lx. |
| 5003 |
Value@Effect |
| 5004 |
0@\[dq]. \[dq] |
| 5005 |
1@\[dq] \[em] \[dq] |
| 5006 |
.TE |
| 5007 |
. |
| 5008 |
. |
| 5009 |
.TP |
| 5010 |
.B P |
| 5011 |
interpolates the current page number; |
| 5012 |
it is the same as |
| 5013 |
.RB register\~ % |
| 5014 |
except when |
| 5015 |
\[lq]section-page\[rq] numbering is enabled. |
| 5016 |
. |
| 5017 |
. |
| 5018 |
.TP |
| 5019 |
.B Pi |
| 5020 |
configures the amount of indentation in ens applied to the first line of |
| 5021 |
a paragraph; |
| 5022 |
see |
| 5023 |
.B P |
| 5024 |
.RB ( 5 ). |
| 5025 |
. |
| 5026 |
. |
| 5027 |
.TP |
| 5028 |
.B Pgps |
| 5029 |
causes the type size and vertical spacing set by |
| 5030 |
.B S |
| 5031 |
to apply to headers and footers, |
| 5032 |
overriding the |
| 5033 |
.B HP |
| 5034 |
string. |
| 5035 |
. |
| 5036 |
If not set, |
| 5037 |
.B S |
| 5038 |
calls affect headers and footers only when followed by |
| 5039 |
.BR PH , |
| 5040 |
.BR PF , |
| 5041 |
.BR OH , |
| 5042 |
.BR EH , |
| 5043 |
.BR OF , |
| 5044 |
or |
| 5045 |
.B OE |
| 5046 |
calls |
| 5047 |
(Boolean-valued; |
| 5048 |
.BR 1 ). |
| 5049 |
. |
| 5050 |
. |
| 5051 |
.TP |
| 5052 |
.B Ps |
| 5053 |
is multiplied by register |
| 5054 |
.B Lsp |
| 5055 |
to vertically separate paragraphs; |
| 5056 |
see |
| 5057 |
.B P |
| 5058 |
.RB ( 1 ). |
| 5059 |
. |
| 5060 |
. |
| 5061 |
.TP |
| 5062 |
.B Pt |
| 5063 |
determines when a first-line indentation is applied to a paragraph; |
| 5064 |
see |
| 5065 |
.B P |
| 5066 |
.RB ( 0 ). |
| 5067 |
. |
| 5068 |
. |
| 5069 |
.IP |
| 5070 |
.TS |
| 5071 |
tab(@); |
| 5072 |
Lb Lb |
| 5073 |
L Lx. |
| 5074 |
Value@Effect |
| 5075 |
0@never |
| 5076 |
1@always |
| 5077 |
2@T{ |
| 5078 |
always, |
| 5079 |
except immediately after |
| 5080 |
.BR H , |
| 5081 |
.BR DE , |
| 5082 |
or |
| 5083 |
.B LE |
| 5084 |
T} |
| 5085 |
.TE |
| 5086 |
. |
| 5087 |
. |
| 5088 |
.TP |
| 5089 |
.B Ref |
| 5090 |
is used internally to control |
| 5091 |
.MR mmroff 1 's |
| 5092 |
two-pass approach to index and reference management; |
| 5093 |
see |
| 5094 |
.B INITI |
| 5095 |
and |
| 5096 |
.B RS |
| 5097 |
(Boolean-valued; |
| 5098 |
.BR 0 ). |
| 5099 |
. |
| 5100 |
. |
| 5101 |
.\" XXX: Why is this not named `Rpej`? |
| 5102 |
.TP |
| 5103 |
.B Rpe |
| 5104 |
configures the default page ejection policy for reference pages; |
| 5105 |
see |
| 5106 |
.B RP |
| 5107 |
.RB ( 0 ). |
| 5108 |
. |
| 5109 |
. |
| 5110 |
.IP |
| 5111 |
.TS |
| 5112 |
tab(@); |
| 5113 |
Lb Lb |
| 5114 |
L Lx. |
| 5115 |
Value@Effect |
| 5116 |
0@Break the page before and after the list of references. |
| 5117 |
1@Suppress page break after the list. |
| 5118 |
2@Suppress page break before the list. |
| 5119 |
3@Suppress page breaks before and after the list. |
| 5120 |
.TE |
| 5121 |
. |
| 5122 |
. |
| 5123 |
.TP |
| 5124 |
.B S |
| 5125 |
defines the type size for the document, |
| 5126 |
and must be set from the command line. |
| 5127 |
. |
| 5128 |
A scaling unit should be appended; |
| 5129 |
.B p |
| 5130 |
is typical |
| 5131 |
.RB ( 10p ). |
| 5132 |
. |
| 5133 |
. |
| 5134 |
.TP |
| 5135 |
.B Sectf |
| 5136 |
selects the \[lq]section-figure\[rq] numbering style. |
| 5137 |
. |
| 5138 |
Its default |
| 5139 |
.RB is\~ 0 |
| 5140 |
unless |
| 5141 |
.RB register\~ N |
| 5142 |
is set |
| 5143 |
.RB to\~ 5 |
| 5144 |
at the command line |
| 5145 |
(Boolean-valued). |
| 5146 |
. |
| 5147 |
. |
| 5148 |
.TP |
| 5149 |
.B Sectp |
| 5150 |
selects the \[lq]section-page\[rq] numbering style. |
| 5151 |
. |
| 5152 |
Its default |
| 5153 |
.RB is\~ 0 |
| 5154 |
unless |
| 5155 |
.RB register\~ N |
| 5156 |
is set |
| 5157 |
.RB to\~ 3 |
| 5158 |
.RB or\~ 5 |
| 5159 |
at the command line |
| 5160 |
(Boolean-valued). |
| 5161 |
. |
| 5162 |
. |
| 5163 |
.TP |
| 5164 |
.B Si |
| 5165 |
configures the amount of display indentation in ens; |
| 5166 |
see |
| 5167 |
.B DS |
| 5168 |
.RB ( 5 ). |
| 5169 |
. |
| 5170 |
. |
| 5171 |
.TP |
| 5172 |
.B Tb |
| 5173 |
is an auto-incrementing table counter; |
| 5174 |
see |
| 5175 |
.BR TB . |
| 5176 |
. |
| 5177 |
. |
| 5178 |
.TP |
| 5179 |
.B V |
| 5180 |
defines the vertical spacing for the document, |
| 5181 |
and must be set from the command line. |
| 5182 |
. |
| 5183 |
A scaling unit should be appended; |
| 5184 |
.B p |
| 5185 |
is typical. |
| 5186 |
. |
| 5187 |
The default vertical spacing is 120% of the type size. |
| 5188 |
. |
| 5189 |
. |
| 5190 |
.TP |
| 5191 |
.B Verbin |
| 5192 |
configures the amount of indentation for verbatim displays |
| 5193 |
when indentation is selected; |
| 5194 |
see |
| 5195 |
.B \%VERBON |
| 5196 |
.RB ( 5n ). |
| 5197 |
. |
| 5198 |
. |
| 5199 |
.TP |
| 5200 |
.B W |
| 5201 |
defines the \[lq]width\[rq] |
| 5202 |
of the document |
| 5203 |
(that is, |
| 5204 |
the length of an output line with no indentation); |
| 5205 |
it must be set from the command line. |
| 5206 |
. |
| 5207 |
A scaling unit should be appended. |
| 5208 |
. |
| 5209 |
The default |
| 5210 |
.RB is\~ 6i |
| 5211 |
or assigned by the |
| 5212 |
.I papersize.tmac |
| 5213 |
package; |
| 5214 |
see |
| 5215 |
.MR groff_tmac 5 . |
| 5216 |
. |
| 5217 |
. |
| 5218 |
. |
| 5219 |
.\" ==================================================================== |
| 5220 |
.SH Internals |
| 5221 |
.\" ==================================================================== |
| 5222 |
. |
| 5223 |
The |
| 5224 |
.B LT |
| 5225 |
letter macros call further macros depending on the letter type, |
| 5226 |
with which they are suffixed. |
| 5227 |
. |
| 5228 |
It is therefore possible to define additional letter types, |
| 5229 |
either in the territory-specific macro file, |
| 5230 |
or as local additions. |
| 5231 |
. |
| 5232 |
.B LT |
| 5233 |
sets the registers |
| 5234 |
.B Pt |
| 5235 |
and |
| 5236 |
.B Pi |
| 5237 |
to 0 and\~5, \" XXX: ...but doesn't use Pi for indentation... |
| 5238 |
respectively. |
| 5239 |
.\" XXX: and why aren't both of these actions the responsibility of |
| 5240 |
.\" let@init_type as described below? |
| 5241 |
. |
| 5242 |
The following macros must be defined to support a new letter type. |
| 5243 |
. |
| 5244 |
. |
| 5245 |
.TP |
| 5246 |
.BI let@init_ type |
| 5247 |
.B LT |
| 5248 |
calls this macro to initialize any registers and other data needed by |
| 5249 |
the letter type. |
| 5250 |
. |
| 5251 |
. |
| 5252 |
.TP |
| 5253 |
.BI let@head_ type |
| 5254 |
formats the letterhead; |
| 5255 |
it is called instead of the usual page header macro. |
| 5256 |
. |
| 5257 |
Its definition should remove the alias |
| 5258 |
.B let@header |
| 5259 |
unless the letterhead is desired on subsequent pages. |
| 5260 |
. |
| 5261 |
. |
| 5262 |
.TP |
| 5263 |
.BI let@sg_ type\~\c |
| 5264 |
.IR "name title n is-final\~" [ SG-arg\~ .\|.\|.] |
| 5265 |
.B SG |
| 5266 |
calls this macro only for letters; |
| 5267 |
.B MT |
| 5268 |
memoranda have their own signature processing. |
| 5269 |
. |
| 5270 |
.I name |
| 5271 |
and |
| 5272 |
.I title |
| 5273 |
are specified through |
| 5274 |
.BR WA / WE . |
| 5275 |
. |
| 5276 |
.IR n \~is |
| 5277 |
the index of the |
| 5278 |
.IR n th |
| 5279 |
writer, |
| 5280 |
and |
| 5281 |
.I is-final |
| 5282 |
is true for the last writer to be listed. |
| 5283 |
. |
| 5284 |
Further |
| 5285 |
.B SG |
| 5286 |
arguments are appended to the signature line. |
| 5287 |
. |
| 5288 |
. |
| 5289 |
.TP |
| 5290 |
.BI let@fc_ "type closing" |
| 5291 |
This macro is called by |
| 5292 |
.BR FC , |
| 5293 |
and has the formal closing as the argument. |
| 5294 |
. |
| 5295 |
. |
| 5296 |
.P |
| 5297 |
.B LO |
| 5298 |
implements letter options. |
| 5299 |
. |
| 5300 |
It requires that a string named |
| 5301 |
.BI Let type |
| 5302 |
be defined, |
| 5303 |
where |
| 5304 |
.I type |
| 5305 |
is the letter type. |
| 5306 |
. |
| 5307 |
.B LO |
| 5308 |
then assigns its second argument |
| 5309 |
.RI ( value ) |
| 5310 |
to the string |
| 5311 |
.BI let*lo\- type\c |
| 5312 |
\&. |
| 5313 |
. |
| 5314 |
. |
| 5315 |
.\" ==================================================================== |
| 5316 |
.\".SH BUGS |
| 5317 |
.\" ==================================================================== |
| 5318 |
. |
| 5319 |
. |
| 5320 |
.\" ==================================================================== |
| 5321 |
.SH Files |
| 5322 |
.\" ==================================================================== |
| 5323 |
. |
| 5324 |
.TP |
| 5325 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\%m.tmac |
| 5326 |
is the |
| 5327 |
.I groff |
| 5328 |
implementation of the memorandum macros. |
| 5329 |
. |
| 5330 |
. |
| 5331 |
.TP |
| 5332 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm.tmac |
| 5333 |
is wrapper to load |
| 5334 |
.IR m.tmac . |
| 5335 |
. |
| 5336 |
. |
| 5337 |
.TP |
| 5338 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/refer\-mm.tmac |
| 5339 |
implements |
| 5340 |
.MR \%refer 1 |
| 5341 |
support for |
| 5342 |
.IR mm . |
| 5343 |
. |
| 5344 |
. |
| 5345 |
.TP |
| 5346 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/ms.cov |
| 5347 |
implements an |
| 5348 |
.IR ms -like |
| 5349 |
cover sheet. |
| 5350 |
. |
| 5351 |
. |
| 5352 |
.TP |
| 5353 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/0.MT |
| 5354 |
implements memorandum types 0\[en]3 and 6. |
| 5355 |
. |
| 5356 |
. |
| 5357 |
.TP |
| 5358 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/4.MT |
| 5359 |
implements memorandum type 4. |
| 5360 |
. |
| 5361 |
. |
| 5362 |
.TP |
| 5363 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/5.MT |
| 5364 |
implements memorandum type 5. |
| 5365 |
. |
| 5366 |
. |
| 5367 |
.TP |
| 5368 |
.I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/mm/locale |
| 5369 |
performs any (further) desired necessary localization; |
| 5370 |
empty by default. |
| 5371 |
. |
| 5372 |
. |
| 5373 |
.\" ==================================================================== |
| 5374 |
.SH Authors |
| 5375 |
.\" ==================================================================== |
| 5376 |
. |
| 5377 |
The GNU version of the |
| 5378 |
.I mm |
| 5379 |
macro package was written by |
| 5380 |
.MT jh@\:axis\:.se |
| 5381 |
J\[:o]rgen H\[:a]gg |
| 5382 |
.ME |
| 5383 |
of Lund, Sweden. |
| 5384 |
. |
| 5385 |
. |
| 5386 |
.\" ==================================================================== |
| 5387 |
.SH "See also" |
| 5388 |
.\" ==================================================================== |
| 5389 |
. |
| 5390 |
.UR https://tkurtbond\:.github\:.io/\:troff/\:mm\-all\:.pdf |
| 5391 |
.I MM \- A Macro Package for Generating Documents |
| 5392 |
.UE , |
| 5393 |
the DWB\~3.3 |
| 5394 |
.I mm |
| 5395 |
manual, |
| 5396 |
introduces the package but does not document GNU extensions. |
| 5397 |
. |
| 5398 |
. |
| 5399 |
.P |
| 5400 |
.IR "Groff: The GNU Implementation of troff" , |
| 5401 |
by Trent A.\& Fisher and Werner Lemberg, |
| 5402 |
is the primary |
| 5403 |
.I groff |
| 5404 |
manual. |
| 5405 |
. |
| 5406 |
You can browse it interactively with \[lq]info groff\[rq]. |
| 5407 |
. |
| 5408 |
. |
| 5409 |
.P |
| 5410 |
.MR groff 1 , |
| 5411 |
.MR \%troff 1 , |
| 5412 |
.MR \%tbl 1 , |
| 5413 |
.MR \%pic 1 , |
| 5414 |
.MR \%eqn 1 , |
| 5415 |
.MR \%refer 1 , |
| 5416 |
.MR groff_mmse 7 |
| 5417 |
(only in Swedish locales) |
| 5418 |
. |
| 5419 |
. |
| 5420 |
.\" Restore compatibility mode (for, e.g., Solaris 10/11). |
| 5421 |
.cp \n[*groff_groff_mm_7_man_C] |
| 5422 |
.do rr *groff_groff_mm_7_man_C |
| 5423 |
. |
| 5424 |
. |
| 5425 |
.\" Local Variables: |
| 5426 |
.\" fill-column: 72 |
| 5427 |
.\" mode: nroff |
| 5428 |
.\" End: |
| 5429 |
.\" vim: set filetype=groff textwidth=72: |