| 1 |
'\" t |
| 2 |
.TH groff_ms 7 "2026-04-22" "groff 1.24.1" |
| 3 |
.SH Name |
| 4 |
groff_ms \- GNU |
| 5 |
.I roff |
| 6 |
manuscript macro package for formatting documents |
| 7 |
. |
| 8 |
. |
| 9 |
.\" ==================================================================== |
| 10 |
.\" Legal Terms |
| 11 |
.\" ==================================================================== |
| 12 |
.\" |
| 13 |
.\" Copyright 1989-2025 Free Software Foundation, Inc. |
| 14 |
.\" |
| 15 |
.\" Permission is granted to make and distribute verbatim copies of this |
| 16 |
.\" manual provided the copyright notice and this permission notice are |
| 17 |
.\" preserved on all copies. |
| 18 |
.\" |
| 19 |
.\" Permission is granted to copy and distribute modified versions of |
| 20 |
.\" this manual under the conditions for verbatim copying, provided that |
| 21 |
.\" the entire resulting derived work is distributed under the terms of |
| 22 |
.\" a permission notice identical to this one. |
| 23 |
.\" |
| 24 |
.\" Permission is granted to copy and distribute translations of this |
| 25 |
.\" manual into another language, under the above conditions for |
| 26 |
.\" modified versions, except that this permission notice may be |
| 27 |
.\" included in translations approved by the Free Software Foundation |
| 28 |
.\" instead of in the original English. |
| 29 |
. |
| 30 |
. |
| 31 |
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). |
| 32 |
.do nr *groff_groff_ms_7_man_C \n[.cp] |
| 33 |
.cp 0 |
| 34 |
. |
| 35 |
.\" Define fallback for groff 1.23's MR macro if the system lacks it. |
| 36 |
.nr do-fallback 0 |
| 37 |
.if !\n(.f .nr do-fallback 1 \" mandoc |
| 38 |
.if \n(.g .if !d MR .nr do-fallback 1 \" older groff |
| 39 |
.if !\n(.g .nr do-fallback 1 \" non-groff *roff |
| 40 |
.if \n[do-fallback] \{\ |
| 41 |
. de MR |
| 42 |
. ie \\n(.$=1 \ |
| 43 |
. I \%\\$1 |
| 44 |
. el \ |
| 45 |
. IR \%\\$1 (\\$2)\\$3 |
| 46 |
. . |
| 47 |
.\} |
| 48 |
.rr do-fallback |
| 49 |
. |
| 50 |
. |
| 51 |
.\" ==================================================================== |
| 52 |
.SH Synopsis |
| 53 |
.\" ==================================================================== |
| 54 |
. |
| 55 |
.SY "groff \-m\%s" |
| 56 |
.RI [ option\~ .\|.\|.\&] |
| 57 |
.RI [ file\~ .\|.\|.] |
| 58 |
.YS |
| 59 |
. |
| 60 |
.SY "groff \-m m\%s" |
| 61 |
.RI [ option\~ .\|.\|.\&] |
| 62 |
.RI [ file\~ .\|.\|.] |
| 63 |
.YS |
| 64 |
. |
| 65 |
. |
| 66 |
.\" ==================================================================== |
| 67 |
.SH Description |
| 68 |
.\" ==================================================================== |
| 69 |
. |
| 70 |
The GNU implementation of the |
| 71 |
.I ms |
| 72 |
macro package is part of the |
| 73 |
.I groff |
| 74 |
document formatting system. |
| 75 |
. |
| 76 |
The |
| 77 |
.I ms |
| 78 |
package is suitable for the composition of |
| 79 |
letters, |
| 80 |
memoranda, |
| 81 |
reports, |
| 82 |
and books. |
| 83 |
. |
| 84 |
. |
| 85 |
.LP |
| 86 |
These |
| 87 |
.I groff |
| 88 |
macros support cover page and table of contents generation, |
| 89 |
automatically numbered headings, |
| 90 |
several paragraph styles, |
| 91 |
a variety of text styling options, |
| 92 |
footnotes, |
| 93 |
and multi-column page layouts. |
| 94 |
. |
| 95 |
.I ms |
| 96 |
supports the |
| 97 |
.MR \%tbl 1 , |
| 98 |
.MR \%eqn 1 , |
| 99 |
.MR \%pic 1 , |
| 100 |
and |
| 101 |
.MR \%refer 1 |
| 102 |
preprocessors for inclusion of tables, |
| 103 |
mathematical equations, |
| 104 |
diagrams, |
| 105 |
and consistently formatted bibliographic citations. |
| 106 |
. |
| 107 |
. |
| 108 |
.P |
| 109 |
.I "groff ms" |
| 110 |
is mostly compatible with the documented interface |
| 111 |
and behavior of AT&T Unix Version\~7 |
| 112 |
.IR ms . |
| 113 |
. |
| 114 |
It recreates most extensions from 4.2BSD (Berkeley) |
| 115 |
.\" Few changes were made in 4.3, Reno, Tahoe, or 4.4. |
| 116 |
and Research Tenth Edition Unix. |
| 117 |
. |
| 118 |
. |
| 119 |
.\" ==================================================================== |
| 120 |
.SH "Document structure" |
| 121 |
.\" ==================================================================== |
| 122 |
. |
| 123 |
The |
| 124 |
.I ms |
| 125 |
macro package expects a certain amount of structure: |
| 126 |
a well-formed document contains at least one paragraphing or heading |
| 127 |
macro call. |
| 128 |
. |
| 129 |
.\" This sentence is unique to the man page because we omit the "Basic |
| 130 |
.\" information" section from ms.ms. |
| 131 |
To compose a simple document from scratch, |
| 132 |
begin it by calling |
| 133 |
.B LP |
| 134 |
or |
| 135 |
.BR PP . |
| 136 |
. |
| 137 |
Organize longer documents as follows. |
| 138 |
. |
| 139 |
. |
| 140 |
.TP |
| 141 |
.B Document type |
| 142 |
Calling the |
| 143 |
.B RP |
| 144 |
macro at the beginning of your document puts the document description |
| 145 |
(see below) |
| 146 |
on a cover page. |
| 147 |
. |
| 148 |
Otherwise, |
| 149 |
.I ms |
| 150 |
places this information |
| 151 |
on the first page, |
| 152 |
followed immediately by the body text. |
| 153 |
. |
| 154 |
Some document types found in other |
| 155 |
.I ms |
| 156 |
implementations are specific to AT&T or Berkeley, |
| 157 |
and are not supported in |
| 158 |
.IR "groff ms" . |
| 159 |
. |
| 160 |
. |
| 161 |
.TP |
| 162 |
.B "Format and layout" |
| 163 |
By setting registers and strings, |
| 164 |
you can configure your document's typeface, |
| 165 |
margins, |
| 166 |
spacing, |
| 167 |
headers and footers, |
| 168 |
and footnote arrangement. |
| 169 |
. |
| 170 |
See subsection \[lq]Document control settings\[rq] below. |
| 171 |
. |
| 172 |
. |
| 173 |
.TP |
| 174 |
.B Document description |
| 175 |
A document description consists of any of: |
| 176 |
a title, |
| 177 |
one or more authors' names and affiliated institutions, |
| 178 |
an abstract, |
| 179 |
and a date or other identifier. |
| 180 |
. |
| 181 |
See subsection \[lq]Document description macros\[rq] below. |
| 182 |
. |
| 183 |
. |
| 184 |
.TP |
| 185 |
.B Body text |
| 186 |
The main matter of your document follows its description |
| 187 |
(if any). |
| 188 |
. |
| 189 |
.I ms |
| 190 |
supports highly structured text consisting of paragraphs interspersed |
| 191 |
with multi-level headings |
| 192 |
(chapters, |
| 193 |
sections, |
| 194 |
subsections, |
| 195 |
and so forth) |
| 196 |
and augmented by lists, |
| 197 |
footnotes, |
| 198 |
tables, |
| 199 |
diagrams, |
| 200 |
and similar material. |
| 201 |
. |
| 202 |
The preponderance of subsections below covers these matters. |
| 203 |
. |
| 204 |
. |
| 205 |
.TP |
| 206 |
.B "Table of contents" |
| 207 |
Macros enable the collection of entries for a table of contents |
| 208 |
(or index) |
| 209 |
as the material they discuss appears in the document. |
| 210 |
. |
| 211 |
A macro call at the end of the document emits the collected entries. |
| 212 |
. |
| 213 |
This material necessarily follows the rest of the text since GNU |
| 214 |
.I troff \" GNU |
| 215 |
is a single-pass formatter; |
| 216 |
it cannot determine the page number of a division of the text |
| 217 |
until it has been set and output. |
| 218 |
. |
| 219 |
Since |
| 220 |
.I ms |
| 221 |
output was designed for the production of hard copy, |
| 222 |
the traditional procedure was to manually relocate the pages containing |
| 223 |
the table of contents between the cover page and the body text. |
| 224 |
. |
| 225 |
Today, |
| 226 |
page resequencing is more often done in the digital domain. |
| 227 |
. |
| 228 |
An index works similarly, |
| 229 |
but because it typically needs to be sorted after collection, |
| 230 |
its preparation requires separate processing. |
| 231 |
. |
| 232 |
. |
| 233 |
.\" ==================================================================== |
| 234 |
.SS "Document control settings" |
| 235 |
.\" ==================================================================== |
| 236 |
. |
| 237 |
The following tables list the document control registers, |
| 238 |
strings, |
| 239 |
and special characters. |
| 240 |
. |
| 241 |
For any parameter whose default is unsatisfactory, |
| 242 |
define it before calling any |
| 243 |
.I ms |
| 244 |
macro other than |
| 245 |
.BR RP . |
| 246 |
. |
| 247 |
. |
| 248 |
.LP |
| 249 |
.ne 7v |
| 250 |
.TS |
| 251 |
cb s s s |
| 252 |
cb cb cb cb |
| 253 |
lf(CR) lx l lf(CR). |
| 254 |
Margin settings |
| 255 |
Parameter Definition Effective Default |
| 256 |
_ |
| 257 |
\[rs]n[PO] Page offset (left margin) next page 1i (0) |
| 258 |
\[rs]n[LL] Line length next paragraph 6.5i (65n) |
| 259 |
\[rs]n[LT] Title line length next paragraph 6.5i (65n) |
| 260 |
\[rs]n[HM] Top (header) margin next page 1i |
| 261 |
\[rs]n[FM] Bottom (footer) margin next page 1i |
| 262 |
_ |
| 263 |
.TE |
| 264 |
. |
| 265 |
. |
| 266 |
.LP |
| 267 |
.ne 8v |
| 268 |
.TS |
| 269 |
cb s s s |
| 270 |
cb cb cb cb |
| 271 |
lf(CR) lx l lf(CR). |
| 272 |
Titles (headers, footers) |
| 273 |
Parameter Definition Effective Default |
| 274 |
_ |
| 275 |
\[rs]*[LH] Left header text next header \f[I]empty |
| 276 |
\[rs]*[CH] Center header text next header \-\[rs]n[%]\- |
| 277 |
\[rs]*[RH] Right header text next header \f[I]empty |
| 278 |
\[rs]*[LF] Left footer text next footer \f[I]empty |
| 279 |
\[rs]*[CF] Center footer text next footer \f[I]empty |
| 280 |
\[rs]*[RF] Right footer text next footer \f[I]empty |
| 281 |
_ |
| 282 |
.TE |
| 283 |
. |
| 284 |
. |
| 285 |
.LP |
| 286 |
.ne 6v |
| 287 |
.TS |
| 288 |
cb s s s |
| 289 |
cb cb cb cb |
| 290 |
lf(CR) lx l lf(CR). |
| 291 |
Text settings |
| 292 |
Parameter Definition Effective Default |
| 293 |
_ |
| 294 |
\[rs]n[PS] Point (type) size next paragraph 10p |
| 295 |
\[rs]n[VS] Vertical spacing (leading) next paragraph 12p |
| 296 |
\[rs]n[HY] Hyphenation mode next paragraph 6 |
| 297 |
\[rs]*[FAM] Font family next paragraph T |
| 298 |
_ |
| 299 |
.TE |
| 300 |
. |
| 301 |
. |
| 302 |
.LP |
| 303 |
.ne 6v |
| 304 |
.TS |
| 305 |
cb s s s |
| 306 |
cb cb cb cb |
| 307 |
lf(CR)2 lx l lf(CR). |
| 308 |
Paragraph settings |
| 309 |
Parameter Definition Effective Default |
| 310 |
_ |
| 311 |
\[rs]n[PI] Indentation next paragraph 5n |
| 312 |
\[rs]n[PD] Paragraph distance (spacing) next paragraph 0.3v\ |
| 313 |
\f[R](\f[]1v\f[R]) |
| 314 |
\[rs]n[QI] Quotation indentation next paragraph 5n |
| 315 |
\[rs]n[PORPHANS] # of initial lines kept next paragraph 1 |
| 316 |
_ |
| 317 |
.TE |
| 318 |
. |
| 319 |
. |
| 320 |
.ne 10v \" Keep table and subsequent paragraph together. |
| 321 |
.LP |
| 322 |
.TS |
| 323 |
cb s s s |
| 324 |
cb cb cb cb |
| 325 |
lf(CR) lx l lf(CR). |
| 326 |
Heading settings |
| 327 |
Parameter Definition Effective Default |
| 328 |
_ |
| 329 |
\[rs]n[PSINCR] Point (type) size increment next heading 1p |
| 330 |
\[rs]n[GROWPS] Size increase depth limit next heading 0 |
| 331 |
\[rs]n[HORPHANS] # of following lines kept next heading 1 |
| 332 |
\[rs]*[SN\-STYLE] Numbering style (alias) next heading \[rs]*[SN\-DOT] |
| 333 |
_ |
| 334 |
.TE |
| 335 |
. |
| 336 |
. |
| 337 |
.LP |
| 338 |
.B \[rs]*[SN\-STYLE] |
| 339 |
can alternatively be made an alias of |
| 340 |
.B \[rs]*[SN\-NO\-DOT] |
| 341 |
with the |
| 342 |
.B als |
| 343 |
request. |
| 344 |
. |
| 345 |
. |
| 346 |
.LP |
| 347 |
.ne 8v |
| 348 |
.TS |
| 349 |
cb s s s |
| 350 |
cb cb cb cb |
| 351 |
lf(CR) lx l lf(CR). |
| 352 |
Footnote settings |
| 353 |
Parameter Definition Effective Default |
| 354 |
_ |
| 355 |
\[rs]n[FI] Indentation next footnote 2n |
| 356 |
\[rs]n[FF] Format next footnote 0 |
| 357 |
\[rs]n[FPS] Point (type) size next footnote \[rs]n[PS]\-2p |
| 358 |
\[rs]n[FVS] Vertical spacing (leading) next footnote \[rs]n[FPS]+2p |
| 359 |
\[rs]n[FPD] Paragraph distance (spacing) next footnote \[rs]n[PD]/2 |
| 360 |
\[rs]*[FR] Line length ratio \f[I]special 11/12 |
| 361 |
_ |
| 362 |
.TE |
| 363 |
. |
| 364 |
. |
| 365 |
.LP |
| 366 |
.ne 4v |
| 367 |
.TS |
| 368 |
cb s s s |
| 369 |
cb cb cb cb |
| 370 |
lf(CR) lx l lf(CR). |
| 371 |
Display settings |
| 372 |
Parameter Definition Effective Default |
| 373 |
_ |
| 374 |
\[rs]n[DD] Display distance (spacing) \f[I]special 0.5v\ |
| 375 |
\f[R](\f[]1v\f[R]) |
| 376 |
\[rs]n[DI] Display indentation \f[I]special 0.5i |
| 377 |
_ |
| 378 |
.TE |
| 379 |
. |
| 380 |
. |
| 381 |
.LP |
| 382 |
.ne 3v |
| 383 |
.TS |
| 384 |
cb s s s |
| 385 |
cb cb cb cb |
| 386 |
lf(CR) lx l lf(CR). |
| 387 |
Other settings |
| 388 |
Parameter Definition Effective Default |
| 389 |
_ |
| 390 |
\[rs]n[MINGW] Minimum gutter width next page 2n |
| 391 |
\[rs]n[TC\-MARGIN] TOC page number margin width \ |
| 392 |
next \f[B]PX\f[] call \[rs]w\[aq]000\[aq] |
| 393 |
\[rs][TC\-LEADER] TOC leader character next \f[B]PX\f[] call\ |
| 394 |
.\[rs]h\[aq]1m\[aq] |
| 395 |
_ |
| 396 |
.TE |
| 397 |
. |
| 398 |
. |
| 399 |
.LP |
| 400 |
For entries marked |
| 401 |
.RI \[lq] special \[rq] |
| 402 |
in the \[lq]Effective\[rq] column, |
| 403 |
see the discussion in the applicable section below. |
| 404 |
. |
| 405 |
The |
| 406 |
.BR PO , |
| 407 |
.BR LL , |
| 408 |
and |
| 409 |
.B LT |
| 410 |
register defaults vary by output device and paper format; |
| 411 |
the values shown are for typesetters using U.S.\& letter paper, |
| 412 |
and then terminals. |
| 413 |
. |
| 414 |
See section \[lq]Paper format\[rq] of |
| 415 |
.MR groff 1 . |
| 416 |
. |
| 417 |
The |
| 418 |
.B PD |
| 419 |
and |
| 420 |
.B DD |
| 421 |
registers use the larger value if the vertical motion quantum of the |
| 422 |
output device is too coarse for the smaller one; |
| 423 |
usually, |
| 424 |
this is the case only for output to terminals. |
| 425 |
. |
| 426 |
The \[lq]gutter\[rq] affected by |
| 427 |
.B \[rs]n[MINGW] |
| 428 |
is the gap between columns in multiple-column page arrangements. |
| 429 |
. |
| 430 |
The |
| 431 |
.B TC\-MARGIN |
| 432 |
register and |
| 433 |
.B TC\-LEADER |
| 434 |
special character affect the formatting of tables of contents assembled |
| 435 |
by the |
| 436 |
.BR XS , |
| 437 |
.BR XA , |
| 438 |
and |
| 439 |
.B XE |
| 440 |
macros. |
| 441 |
. |
| 442 |
. |
| 443 |
.\" ==================================================================== |
| 444 |
.SS "Document description macros" |
| 445 |
.\" ==================================================================== |
| 446 |
. |
| 447 |
Define information describing the document by calling the macros below |
| 448 |
in the order shown; |
| 449 |
.B DA |
| 450 |
or |
| 451 |
.B ND |
| 452 |
can be called to set the document date |
| 453 |
(or other identifier) |
| 454 |
at any time before (a) the abstract, |
| 455 |
if present, |
| 456 |
or (b) its information is required in a header or footer. |
| 457 |
. |
| 458 |
Use of these macros is optional, |
| 459 |
except that |
| 460 |
.B TL |
| 461 |
is mandatory if any of |
| 462 |
.BR RP , |
| 463 |
.BR AU , |
| 464 |
.BR AI , |
| 465 |
or |
| 466 |
.B AB |
| 467 |
is called, |
| 468 |
and |
| 469 |
.B AE |
| 470 |
is mandatory if |
| 471 |
.B AB |
| 472 |
is called. |
| 473 |
. |
| 474 |
. |
| 475 |
.TP |
| 476 |
.BR .RP\~ [ no\-repeat\-info ]\~[ no\-renumber ] |
| 477 |
Use the \[lq]report\[rq] |
| 478 |
(AT&T: \[lq]released paper\[rq]) |
| 479 |
format for your document, |
| 480 |
creating a separate cover page. |
| 481 |
. |
| 482 |
The default arrangement is to place most of the document description |
| 483 |
(title, |
| 484 |
author names and institutions, |
| 485 |
and abstract, |
| 486 |
but not the date) |
| 487 |
at the top of the first page. |
| 488 |
. |
| 489 |
If the optional |
| 490 |
.B no\-\:\%repeat\-\:\%info |
| 491 |
argument is given, |
| 492 |
.I ms |
| 493 |
produces a cover page but does not repeat any of its information |
| 494 |
subsequently |
| 495 |
(but see the |
| 496 |
.B DA |
| 497 |
macro below regarding the date). |
| 498 |
. |
| 499 |
Normally, |
| 500 |
.B RP |
| 501 |
sets the page number following the cover page to\~1. |
| 502 |
. |
| 503 |
Specifying the optional |
| 504 |
.B no\-\:\%renumber |
| 505 |
argument suppresses this alteration. |
| 506 |
. |
| 507 |
Optional arguments can occur in any order. |
| 508 |
. |
| 509 |
.I ms |
| 510 |
recognizes |
| 511 |
.B no |
| 512 |
as a synonym of |
| 513 |
.B no\-\:\%repeat\-\:\%info |
| 514 |
to maintain AT&T compatibility. |
| 515 |
. |
| 516 |
Options other than |
| 517 |
.B no |
| 518 |
are GNU extensions. |
| 519 |
. |
| 520 |
. |
| 521 |
.TP |
| 522 |
.B .TL |
| 523 |
Specify the document title. |
| 524 |
. |
| 525 |
.I ms |
| 526 |
collects text on input lines following this call into the title until |
| 527 |
reaching |
| 528 |
.BR AU , |
| 529 |
.BR AB , |
| 530 |
or a heading or paragraphing macro call. |
| 531 |
. |
| 532 |
. |
| 533 |
.TP |
| 534 |
.B .AU |
| 535 |
Specify an author's name. |
| 536 |
. |
| 537 |
.I ms |
| 538 |
collects text on input lines following this call into the author's name |
| 539 |
until reaching |
| 540 |
.BR AI , |
| 541 |
.BR AB , |
| 542 |
another |
| 543 |
.BR AU , |
| 544 |
or a heading or paragraphing macro call. |
| 545 |
. |
| 546 |
Call it repeatedly to specify multiple authors. |
| 547 |
. |
| 548 |
. |
| 549 |
.TP |
| 550 |
.B .AI |
| 551 |
Specify the preceding author's institutional affiliation. |
| 552 |
. |
| 553 |
An |
| 554 |
.B AU |
| 555 |
call is usefully followed by at most one |
| 556 |
.B AI |
| 557 |
call; |
| 558 |
if there are more, |
| 559 |
the last |
| 560 |
.B AI |
| 561 |
call controls. |
| 562 |
. |
| 563 |
.I ms |
| 564 |
collects text on input lines following this call into the author's |
| 565 |
institution until reaching |
| 566 |
.BR AU , |
| 567 |
.BR AB , |
| 568 |
or a heading or paragraphing macro call. |
| 569 |
. |
| 570 |
. |
| 571 |
.TP |
| 572 |
.BR .DA \~[\c |
| 573 |
.IR x \~.\|.\|.] |
| 574 |
Typeset the current date, |
| 575 |
or any |
| 576 |
.RI arguments\~ x , |
| 577 |
in the center footer, |
| 578 |
and, |
| 579 |
if |
| 580 |
.B RP |
| 581 |
is also called, |
| 582 |
left-aligned at the end of the document description on the cover page. |
| 583 |
. |
| 584 |
. |
| 585 |
.TP |
| 586 |
.BR .ND \~[\c |
| 587 |
.IR x \~.\|.\|.] |
| 588 |
Typeset the current date, |
| 589 |
or any |
| 590 |
.RI arguments\~ x , |
| 591 |
if |
| 592 |
.B RP |
| 593 |
is also called, |
| 594 |
left-aligned at the end of the document description on the cover page. |
| 595 |
. |
| 596 |
This is |
| 597 |
.IR "groff ms" 's |
| 598 |
default. |
| 599 |
. |
| 600 |
. |
| 601 |
.TP |
| 602 |
.BR ".AB " [ no ] |
| 603 |
Begin the abstract. |
| 604 |
. |
| 605 |
.I ms |
| 606 |
collects text on input lines following this call into the abstract until |
| 607 |
reaching an |
| 608 |
.B AE |
| 609 |
call. |
| 610 |
. |
| 611 |
By default, |
| 612 |
.I ms |
| 613 |
places the word \[lq]ABSTRACT\[rq] centered and in italics above the |
| 614 |
text of the abstract. |
| 615 |
. |
| 616 |
The optional argument |
| 617 |
.RB \[lq] no \[rq] |
| 618 |
suppresses this heading. |
| 619 |
. |
| 620 |
. |
| 621 |
.TP |
| 622 |
.B .AE |
| 623 |
End the abstract. |
| 624 |
. |
| 625 |
. |
| 626 |
.\" ==================================================================== |
| 627 |
.SS "Text settings" |
| 628 |
.\" ==================================================================== |
| 629 |
. |
| 630 |
The |
| 631 |
.B FAM |
| 632 |
string, |
| 633 |
a GNU extension, |
| 634 |
sets the font family for body text; |
| 635 |
the default is |
| 636 |
.RB \[lq]\^ T \^\[rq]. |
| 637 |
. |
| 638 |
The |
| 639 |
.B PS |
| 640 |
and |
| 641 |
.B VS |
| 642 |
registers set the type size and vertical spacing |
| 643 |
(distance between text baselines), |
| 644 |
respectively. |
| 645 |
. |
| 646 |
The font family and type size are ignored on terminals. |
| 647 |
. |
| 648 |
Set these parameters before the first call of a heading, |
| 649 |
paragraphing, |
| 650 |
or (non-date) document description macro to apply them to |
| 651 |
headers, |
| 652 |
footers, |
| 653 |
and |
| 654 |
(for |
| 655 |
.BR FAM ) |
| 656 |
footnotes. |
| 657 |
. |
| 658 |
. |
| 659 |
.br |
| 660 |
.ne 2v |
| 661 |
.P |
| 662 |
The |
| 663 |
.B HY |
| 664 |
register defines the automatic hyphenation mode used with the |
| 665 |
.B hy |
| 666 |
request. |
| 667 |
. |
| 668 |
Setting |
| 669 |
.B \[rs]n[HY] |
| 670 |
.RB to\~ 0 |
| 671 |
disables automatic hyphenation. |
| 672 |
. |
| 673 |
This is a Research Tenth Edition Unix extension. |
| 674 |
. |
| 675 |
. |
| 676 |
.\" ==================================================================== |
| 677 |
.SS "Typographical symbols" |
| 678 |
.\" ==================================================================== |
| 679 |
. |
| 680 |
.I ms |
| 681 |
provides a few strings to obtain typographical symbols not easily |
| 682 |
entered with the keyboard. |
| 683 |
. |
| 684 |
These and many others are available as special character escape |
| 685 |
sequences\[em]see |
| 686 |
.MR groff_char 7 . |
| 687 |
. |
| 688 |
. |
| 689 |
.TP |
| 690 |
.B \[rs]*[\-] |
| 691 |
Interpolate an em dash. |
| 692 |
. |
| 693 |
. |
| 694 |
.TP |
| 695 |
.B \[rs]*[Q] |
| 696 |
.TQ |
| 697 |
.B \[rs]*[U] |
| 698 |
Interpolate typographer's quotation marks where available, |
| 699 |
and neutral double quotes otherwise. |
| 700 |
. |
| 701 |
.B \[rs]*[Q] |
| 702 |
is the left quote and |
| 703 |
.B \[rs]*[U] |
| 704 |
the right. |
| 705 |
. |
| 706 |
. |
| 707 |
.\" ==================================================================== |
| 708 |
.SS Paragraphs |
| 709 |
.\" ==================================================================== |
| 710 |
. |
| 711 |
Paragraphing macros |
| 712 |
.IR break , |
| 713 |
or terminate, |
| 714 |
any pending output line so that a new paragraph can begin. |
| 715 |
. |
| 716 |
Several paragraph types are available, |
| 717 |
differing in how indentation |
| 718 |
applies to them: |
| 719 |
to left, |
| 720 |
right, |
| 721 |
or both margins; |
| 722 |
to the first output line of the paragraph, |
| 723 |
all output lines, |
| 724 |
or all but the first. |
| 725 |
. |
| 726 |
These calls insert vertical space in the amount stored in the |
| 727 |
.B PD |
| 728 |
register, |
| 729 |
except at page or column breaks, |
| 730 |
or adjacent to displays. |
| 731 |
. |
| 732 |
. |
| 733 |
.PP |
| 734 |
The |
| 735 |
.B PORPHANS |
| 736 |
register defines the minimum number of initial lines of any paragraph |
| 737 |
that must be kept together to avoid isolated lines at the bottom of a |
| 738 |
page. |
| 739 |
. |
| 740 |
If a new paragraph starts close to the bottom of a page, |
| 741 |
and there is insufficient space to accommodate |
| 742 |
.B \[rs]n[PORPHANS] |
| 743 |
lines before an automatic page break, |
| 744 |
.I "groff ms" |
| 745 |
forces a page break before formatting the paragraph. |
| 746 |
. |
| 747 |
This is a GNU extension. |
| 748 |
. |
| 749 |
. |
| 750 |
.TP |
| 751 |
.B .LP |
| 752 |
Set a paragraph without any (additional) indentation. |
| 753 |
. |
| 754 |
. |
| 755 |
.TP |
| 756 |
.B .PP |
| 757 |
Set a paragraph with a first-line left indentation in the amount stored |
| 758 |
in the |
| 759 |
.B PI |
| 760 |
register. |
| 761 |
. |
| 762 |
. |
| 763 |
.TP |
| 764 |
.BR .IP \~[\c |
| 765 |
.IR mark \~[ width ]] |
| 766 |
Set a paragraph with a left indentation. |
| 767 |
. |
| 768 |
The optional |
| 769 |
.I mark |
| 770 |
is not indented, |
| 771 |
is useful in the construction of lists, |
| 772 |
and is empty by default. |
| 773 |
. |
| 774 |
.I width |
| 775 |
overrides the indentation amount in |
| 776 |
.BR \[rs]n[PI] ; |
| 777 |
its default unit is |
| 778 |
.RB \[lq] n \[rq]. |
| 779 |
. |
| 780 |
Once specified, |
| 781 |
.I width |
| 782 |
applies to further |
| 783 |
.B IP |
| 784 |
calls until specified again or a heading or different paragraphing macro |
| 785 |
is called. |
| 786 |
. |
| 787 |
. |
| 788 |
.TP |
| 789 |
.B .QP |
| 790 |
Set a paragraph indented from both left and right margins by |
| 791 |
.BR \[rs]n[QI] . |
| 792 |
. |
| 793 |
. |
| 794 |
.TP |
| 795 |
.B .QS |
| 796 |
.TQ |
| 797 |
.B .QE |
| 798 |
Begin |
| 799 |
.RB ( QS ) |
| 800 |
and end |
| 801 |
.RB ( QE ) |
| 802 |
a region where each paragraph is indented from both margins by |
| 803 |
.BR \[rs]n[QI] . |
| 804 |
. |
| 805 |
The text between |
| 806 |
.B QS |
| 807 |
and |
| 808 |
.B QE |
| 809 |
can be structured further by use of other paragraphing macros. |
| 810 |
. |
| 811 |
. |
| 812 |
.TP |
| 813 |
.B .XP |
| 814 |
Set an \[lq]exdented\[rq] paragraph\[em]one with a left indentation of |
| 815 |
.B \[rs]n[PI] |
| 816 |
on every line |
| 817 |
.I except |
| 818 |
the first |
| 819 |
(also known as a hanging indent). |
| 820 |
. |
| 821 |
This is a Berkeley extension. |
| 822 |
. |
| 823 |
. |
| 824 |
.\" ==================================================================== |
| 825 |
.SS Headings |
| 826 |
.\" ==================================================================== |
| 827 |
. |
| 828 |
Use headings to create a hierarchical structure for your document. |
| 829 |
. |
| 830 |
The |
| 831 |
.I ms |
| 832 |
macros print headings in |
| 833 |
.B bold |
| 834 |
using the same font family and, |
| 835 |
by default, |
| 836 |
type size as the body text. |
| 837 |
. |
| 838 |
Headings are available with and without automatic numbering. |
| 839 |
. |
| 840 |
Text on input lines following the macro call becomes the heading's |
| 841 |
title. |
| 842 |
. |
| 843 |
Call a paragraphing macro to end the heading text and start the |
| 844 |
section's content. |
| 845 |
. |
| 846 |
. |
| 847 |
.TP |
| 848 |
.BR .NH \~[\c |
| 849 |
.IR depth ] |
| 850 |
Set an automatically numbered heading. |
| 851 |
. |
| 852 |
.I ms |
| 853 |
produces a numbered heading in the form |
| 854 |
.IR a . b . c .\|.\|., |
| 855 |
to any level desired, |
| 856 |
with the numbering of each depth increasing automatically and being |
| 857 |
reset to zero when a more significant depth is increased. |
| 858 |
. |
| 859 |
.RB \[lq] 1 \[rq]\~is |
| 860 |
the most significant or coarsest division of the document. |
| 861 |
. |
| 862 |
Only non-zero values are output. |
| 863 |
. |
| 864 |
If |
| 865 |
.I depth |
| 866 |
is omitted, |
| 867 |
.I ms |
| 868 |
assumes |
| 869 |
.RB \[lq] 1 \[rq]. |
| 870 |
. |
| 871 |
If you specify |
| 872 |
.I depth |
| 873 |
such that an ascending gap occurs relative to the previous |
| 874 |
.B NH |
| 875 |
call\[em]that is, |
| 876 |
you \[lq]skip a depth\[rq], |
| 877 |
as by |
| 878 |
.RB \[lq] ".NH\~1" \[rq] |
| 879 |
and then |
| 880 |
.RB \[lq] ".NH\~3" \[rq], |
| 881 |
.I groff ms |
| 882 |
emits a warning on the standard error stream. |
| 883 |
. |
| 884 |
. |
| 885 |
.TP |
| 886 |
.BI ".NH S\~" heading-depth-index\~\c |
| 887 |
\&.\|.\|. |
| 888 |
Alternatively, |
| 889 |
you can give |
| 890 |
.B NH |
| 891 |
a first argument |
| 892 |
.RB of\~\[lq] S \[rq], |
| 893 |
followed by integers to number the heading depths explicitly. |
| 894 |
. |
| 895 |
Further automatic numbering, |
| 896 |
if used, |
| 897 |
resumes using the specified indices as their predecessors. |
| 898 |
. |
| 899 |
.\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper... |
| 900 |
This feature is a Berkeley extension. |
| 901 |
. |
| 902 |
. |
| 903 |
.br |
| 904 |
.ne 3v |
| 905 |
.P |
| 906 |
After |
| 907 |
.B NH |
| 908 |
is called, |
| 909 |
the assigned number is made available in the strings |
| 910 |
.B SN\-DOT |
| 911 |
(as it appears in a printed heading with default formatting, |
| 912 |
followed by a terminating period) |
| 913 |
and |
| 914 |
.B SN\-NO\-DOT |
| 915 |
(with the terminating period omitted). |
| 916 |
. |
| 917 |
These, |
| 918 |
and |
| 919 |
.BR SN\-STYLE , |
| 920 |
are GNU extensions. |
| 921 |
. |
| 922 |
. |
| 923 |
.P |
| 924 |
You can control the style used to print numbered headings by defining an |
| 925 |
appropriate alias for the string |
| 926 |
.BR SN\-STYLE . |
| 927 |
. |
| 928 |
By default, |
| 929 |
.B \[rs]*[SN\-STYLE] |
| 930 |
is aliased to |
| 931 |
.BR \[rs]*[SN\-DOT] . |
| 932 |
. |
| 933 |
If you prefer to omit the terminating period from numbers appearing in |
| 934 |
numbered headings, |
| 935 |
you may alias it to |
| 936 |
.BR \[rs]*[SN\-NO\-DOT] . |
| 937 |
. |
| 938 |
Any such change in numbering style becomes effective from the next use |
| 939 |
of |
| 940 |
.B NH |
| 941 |
following redefinition of the alias for |
| 942 |
.BR \[rs]*[SN\-STYLE] . |
| 943 |
. |
| 944 |
The formatted number of the current heading is available in |
| 945 |
.B \[rs]*[SN] |
| 946 |
(a feature first documented by Berkeley); |
| 947 |
this string facilitates its inclusion in, |
| 948 |
for example, |
| 949 |
table captions, |
| 950 |
equation labels, |
| 951 |
and |
| 952 |
.BR XS / XA / XE |
| 953 |
table of contents entries. |
| 954 |
. |
| 955 |
. |
| 956 |
.TP |
| 957 |
.BR .SH \~[\c |
| 958 |
.IR depth ] |
| 959 |
Set an unnumbered heading. |
| 960 |
. |
| 961 |
The optional |
| 962 |
.I depth |
| 963 |
argument is a GNU extension indicating the heading depth corresponding |
| 964 |
to the |
| 965 |
.I depth |
| 966 |
argument of |
| 967 |
.BR NH . |
| 968 |
. |
| 969 |
It matches the type size at which the heading is set to that of a |
| 970 |
numbered heading at the same depth when the |
| 971 |
.B \[rs]n[GROWPS] |
| 972 |
and |
| 973 |
.B \[rs]n[PSINCR] |
| 974 |
heading size adjustment mechanism is in effect. |
| 975 |
. |
| 976 |
. |
| 977 |
.P |
| 978 |
The |
| 979 |
.B PSINCR |
| 980 |
register defines an increment in type size to be applied to a heading at |
| 981 |
a lesser depth than that specified in |
| 982 |
.BR \[rs]n[GROWPS] . |
| 983 |
. |
| 984 |
The value of |
| 985 |
.B \[rs]n[PSINCR] |
| 986 |
should be specified in points with the |
| 987 |
.RB \[lq] p \[rq] |
| 988 |
scaling unit and may include a fractional component. |
| 989 |
. |
| 990 |
. |
| 991 |
.P |
| 992 |
The |
| 993 |
.B GROWPS |
| 994 |
register defines the heading depth above which the type size increment |
| 995 |
set by |
| 996 |
.B \[rs]n[PSINCR] |
| 997 |
becomes effective. |
| 998 |
. |
| 999 |
For each heading depth less than the value of |
| 1000 |
.BR \[rs]n[GROWPS] , |
| 1001 |
the type size is increased by |
| 1002 |
.BR \[rs]n[PSINCR] . |
| 1003 |
. |
| 1004 |
Setting |
| 1005 |
.B \[rs]n[GROWPS] |
| 1006 |
to a value less than\~2 disables the incremental heading size feature. |
| 1007 |
. |
| 1008 |
. |
| 1009 |
.P |
| 1010 |
In other words, |
| 1011 |
if the value of |
| 1012 |
.B GROWPS |
| 1013 |
register is greater than the |
| 1014 |
.I depth |
| 1015 |
argument to a |
| 1016 |
.B NH |
| 1017 |
or |
| 1018 |
.B SH |
| 1019 |
call, |
| 1020 |
the type size of a heading produced by these macros increases by |
| 1021 |
.B \[rs]n[PSINCR] |
| 1022 |
units over |
| 1023 |
.B \[rs]n[PS] |
| 1024 |
multiplied by the difference of |
| 1025 |
.B \[rs]n[GROWPS] |
| 1026 |
and |
| 1027 |
.IR depth . |
| 1028 |
. |
| 1029 |
.B GROWPS |
| 1030 |
and |
| 1031 |
.B PSINCR |
| 1032 |
are GNU extensions. |
| 1033 |
. |
| 1034 |
. |
| 1035 |
.P |
| 1036 |
In |
| 1037 |
.I "groff ms," |
| 1038 |
the |
| 1039 |
.B NH |
| 1040 |
and |
| 1041 |
.B SH |
| 1042 |
macros consult the |
| 1043 |
.B HORPHANS |
| 1044 |
register to prevent the output of isolated headings at the bottom of a |
| 1045 |
page; |
| 1046 |
it specifies the minimum number of lines of the subsequent paragraph |
| 1047 |
that must be kept on the same page as the heading. |
| 1048 |
. |
| 1049 |
If insufficient space remains on the current page to accommodate the |
| 1050 |
heading and this number of lines of paragraph text, |
| 1051 |
.I "groff ms" |
| 1052 |
forces a page break before setting the heading. |
| 1053 |
. |
| 1054 |
Any display macro call or |
| 1055 |
.IR tbl , |
| 1056 |
.IR pic , |
| 1057 |
or |
| 1058 |
.I eqn |
| 1059 |
region between the heading and the subsequent paragraph suppresses this |
| 1060 |
grouping. |
| 1061 |
. |
| 1062 |
This is a GNU extension. |
| 1063 |
. |
| 1064 |
. |
| 1065 |
.\" ==================================================================== |
| 1066 |
.SS "Typeface and decoration" |
| 1067 |
.\" ==================================================================== |
| 1068 |
. |
| 1069 |
. |
| 1070 |
.P |
| 1071 |
The |
| 1072 |
.I ms |
| 1073 |
macros provide a variety of ways to style text. |
| 1074 |
. |
| 1075 |
Attend closely to the ordering of arguments labeled |
| 1076 |
.I pre |
| 1077 |
and |
| 1078 |
.I post, |
| 1079 |
which is not intuitive. |
| 1080 |
. |
| 1081 |
Support for |
| 1082 |
.I pre |
| 1083 |
arguments is a GNU extension. |
| 1084 |
. |
| 1085 |
. |
| 1086 |
.TP |
| 1087 |
.BR .B \~[\c |
| 1088 |
.IR text \~[ post \~[ pre ]]] |
| 1089 |
Style |
| 1090 |
.I text |
| 1091 |
in bold, |
| 1092 |
followed by |
| 1093 |
.I post |
| 1094 |
in the previous font style without intervening space, |
| 1095 |
and preceded by |
| 1096 |
.I pre |
| 1097 |
similarly. |
| 1098 |
. |
| 1099 |
Without arguments, |
| 1100 |
.I ms |
| 1101 |
styles subsequent text in bold |
| 1102 |
until the next |
| 1103 |
paragraphing, |
| 1104 |
heading, |
| 1105 |
or no-argument typeface macro call. |
| 1106 |
. |
| 1107 |
. |
| 1108 |
.TP |
| 1109 |
.BR .R \~[\c |
| 1110 |
.IR text \~[ post \~[ pre ]]] |
| 1111 |
As |
| 1112 |
.BR B , |
| 1113 |
but use the roman style |
| 1114 |
(upright text of normal weight) |
| 1115 |
instead of bold. |
| 1116 |
. |
| 1117 |
Argument recognition is a GNU extension. |
| 1118 |
. |
| 1119 |
. |
| 1120 |
.TP |
| 1121 |
.BR .I \~[\c |
| 1122 |
.IR text \~[ post \~[ pre ]]] |
| 1123 |
As |
| 1124 |
.BR B , |
| 1125 |
but use an italic or oblique style instead of bold. |
| 1126 |
. |
| 1127 |
. |
| 1128 |
.TP |
| 1129 |
.BR .BI \~[\c |
| 1130 |
.IR text \~[ post \~[ pre ]]] |
| 1131 |
As |
| 1132 |
.BR B , |
| 1133 |
but use a bold italic or bold oblique style instead of upright bold. |
| 1134 |
. |
| 1135 |
This is a Research Tenth Edition Unix extension. |
| 1136 |
.\" possibly 9th, but definitely not Berkeley |
| 1137 |
. |
| 1138 |
. |
| 1139 |
.TP |
| 1140 |
.BR .CW \~[\c |
| 1141 |
.IR text \~[ post \~[ pre ]]] |
| 1142 |
As |
| 1143 |
.BR B , |
| 1144 |
but use a constant-width (monospaced) roman typeface instead of bold. |
| 1145 |
. |
| 1146 |
This is a Research Tenth Edition Unix extension. |
| 1147 |
.\" possibly 9th, but definitely not Berkeley |
| 1148 |
. |
| 1149 |
. |
| 1150 |
.TP |
| 1151 |
.BR .BX \~[\c |
| 1152 |
.IR text ] |
| 1153 |
Typeset |
| 1154 |
.I text |
| 1155 |
and draw a box around it. |
| 1156 |
. |
| 1157 |
On terminals, |
| 1158 |
reverse video is used instead. |
| 1159 |
. |
| 1160 |
If you want |
| 1161 |
.I text |
| 1162 |
to contain space, |
| 1163 |
use unbreakable space or horizontal motion escape sequences |
| 1164 |
.RB ( \[rs]\[ti] , |
| 1165 |
.BI \[rs] space\c |
| 1166 |
, |
| 1167 |
.BR \[rs]\[ha] , |
| 1168 |
.BR \[rs]| , |
| 1169 |
.BR \[rs]0 , |
| 1170 |
or |
| 1171 |
.BR \[rs]h ). |
| 1172 |
. |
| 1173 |
. |
| 1174 |
.TP |
| 1175 |
.BR .UL \~[\c |
| 1176 |
.IR text \~[ post ]] |
| 1177 |
Typeset |
| 1178 |
.I text |
| 1179 |
with an underline. |
| 1180 |
. |
| 1181 |
On terminals, |
| 1182 |
.I text |
| 1183 |
is bracketed with underscores (\[lq]_\[rq]). |
| 1184 |
. |
| 1185 |
.I post, |
| 1186 |
if present, |
| 1187 |
is set after |
| 1188 |
.I text |
| 1189 |
with no intervening space. |
| 1190 |
. |
| 1191 |
. |
| 1192 |
.TP |
| 1193 |
.B .LG |
| 1194 |
Set subsequent text in larger type |
| 1195 |
(2\~points larger than the current size) |
| 1196 |
until the next |
| 1197 |
type size, |
| 1198 |
paragraphing, |
| 1199 |
or heading macro call. |
| 1200 |
. |
| 1201 |
Call the macro multiple times to enlarge the type size further. |
| 1202 |
. |
| 1203 |
. |
| 1204 |
.TP |
| 1205 |
.B .SM |
| 1206 |
Set subsequent text in smaller type |
| 1207 |
(2\~points smaller than the current size) |
| 1208 |
until the next |
| 1209 |
type size, |
| 1210 |
paragraphing, |
| 1211 |
or heading macro call. |
| 1212 |
. |
| 1213 |
Call the macro multiple times to reduce the type size further. |
| 1214 |
. |
| 1215 |
. |
| 1216 |
.TP |
| 1217 |
.B .NL |
| 1218 |
Set subsequent text at the normal type size |
| 1219 |
.RB ( \[rs]n[PS] ). |
| 1220 |
. |
| 1221 |
. |
| 1222 |
.P |
| 1223 |
When |
| 1224 |
.I pre |
| 1225 |
is used, |
| 1226 |
a hyphenation control escape sequence |
| 1227 |
.B \[rs]% |
| 1228 |
that would ordinarily start |
| 1229 |
.I text |
| 1230 |
must start |
| 1231 |
.I pre |
| 1232 |
instead. |
| 1233 |
. |
| 1234 |
. |
| 1235 |
.P |
| 1236 |
.I groff ms |
| 1237 |
also offers strings to begin and end super- and subscripting. |
| 1238 |
. |
| 1239 |
These are GNU extensions. |
| 1240 |
. |
| 1241 |
. |
| 1242 |
.TP |
| 1243 |
.B \[rs]*{ |
| 1244 |
.TQ |
| 1245 |
.B \[rs]*} |
| 1246 |
Begin and end superscripting, |
| 1247 |
respectively. |
| 1248 |
. |
| 1249 |
. |
| 1250 |
.TP |
| 1251 |
.B \[rs]*< |
| 1252 |
.TQ |
| 1253 |
.B \[rs]*> |
| 1254 |
Begin and end subscripting, |
| 1255 |
respectively. |
| 1256 |
. |
| 1257 |
. |
| 1258 |
.\" ==================================================================== |
| 1259 |
.SS "Indented regions" |
| 1260 |
.\" ==================================================================== |
| 1261 |
. |
| 1262 |
You can indent a region of text while otherwise formatting it normally. |
| 1263 |
. |
| 1264 |
Such indented regions can be nested. |
| 1265 |
. |
| 1266 |
. |
| 1267 |
.TP |
| 1268 |
.B .RS |
| 1269 |
Begin a region where headings, |
| 1270 |
paragraphs, |
| 1271 |
and displays are indented (further) by |
| 1272 |
.BR \[rs]n[PI] . |
| 1273 |
. |
| 1274 |
. |
| 1275 |
.TP |
| 1276 |
.B .RE |
| 1277 |
End the (next) most recent indented region. |
| 1278 |
. |
| 1279 |
. |
| 1280 |
.\" ==================================================================== |
| 1281 |
.SS "Keeps, boxed keeps, and displays" |
| 1282 |
.\" ==================================================================== |
| 1283 |
. |
| 1284 |
On occasion, |
| 1285 |
you may want to |
| 1286 |
.I keep |
| 1287 |
several lines of text, |
| 1288 |
or a region of a document, |
| 1289 |
together on a single page, |
| 1290 |
preventing an automatic page break within certain boundaries. |
| 1291 |
. |
| 1292 |
This can cause a page break to occur earlier than it normally would. |
| 1293 |
. |
| 1294 |
. |
| 1295 |
.P |
| 1296 |
You can alternatively specify a |
| 1297 |
.I floating keep: |
| 1298 |
if a keep cannot fit on the current page, |
| 1299 |
.I ms |
| 1300 |
holds it, |
| 1301 |
allowing text following the keep |
| 1302 |
(in the source document) |
| 1303 |
to fill in the remainder of the current page. |
| 1304 |
. |
| 1305 |
When the page breaks by reaching its bottom or by |
| 1306 |
.B bp |
| 1307 |
request, |
| 1308 |
.I ms |
| 1309 |
puts the floating keep at the beginning of the next page. |
| 1310 |
. |
| 1311 |
. |
| 1312 |
.TP |
| 1313 |
.B .KS |
| 1314 |
Begin a keep. |
| 1315 |
. |
| 1316 |
. |
| 1317 |
.TP |
| 1318 |
.B .KF |
| 1319 |
Begin a floating keep. |
| 1320 |
. |
| 1321 |
. |
| 1322 |
.TP |
| 1323 |
.B .KE |
| 1324 |
End (floating) keep. |
| 1325 |
. |
| 1326 |
. |
| 1327 |
.P |
| 1328 |
As an alternative to the keep mechanism, |
| 1329 |
the |
| 1330 |
.B ne |
| 1331 |
request forces a page break if there is not at least the amount of |
| 1332 |
vertical space specified in its argument remaining on the page. |
| 1333 |
. |
| 1334 |
. |
| 1335 |
.br |
| 1336 |
.ne 5v |
| 1337 |
.PP |
| 1338 |
A |
| 1339 |
.I boxed keep |
| 1340 |
has a frame drawn around it. |
| 1341 |
. |
| 1342 |
. |
| 1343 |
.TP |
| 1344 |
.B .B1 |
| 1345 |
Begin a keep with a box drawn around it. |
| 1346 |
. |
| 1347 |
. |
| 1348 |
.TP |
| 1349 |
.B .B2 |
| 1350 |
End boxed keep. |
| 1351 |
. |
| 1352 |
. |
| 1353 |
.P |
| 1354 |
Boxed keep macros cause breaks; |
| 1355 |
to box words within a line, |
| 1356 |
recall |
| 1357 |
.B BX |
| 1358 |
in section \[lq]Highlighting\[rq] above. |
| 1359 |
. |
| 1360 |
.I ms |
| 1361 |
draws box lines close to the text they enclose |
| 1362 |
so that they are usable within paragraphs. |
| 1363 |
. |
| 1364 |
When boxing entire paragraphs thus, |
| 1365 |
you may improve their appearance by calling |
| 1366 |
.B B1 |
| 1367 |
after the first paragraphing macro, |
| 1368 |
and invoking the |
| 1369 |
.B sp |
| 1370 |
request before calling |
| 1371 |
.BR B2 . |
| 1372 |
. |
| 1373 |
. |
| 1374 |
.P |
| 1375 |
If you want a boxed keep to float, |
| 1376 |
enclose the |
| 1377 |
.B B1 |
| 1378 |
and |
| 1379 |
.B B2 |
| 1380 |
calls within a pair of |
| 1381 |
.B KF |
| 1382 |
and |
| 1383 |
.B KE |
| 1384 |
calls. |
| 1385 |
. |
| 1386 |
. |
| 1387 |
.br |
| 1388 |
.ne 2v |
| 1389 |
.P |
| 1390 |
.I Displays |
| 1391 |
turn off filling; |
| 1392 |
lines of verse or program code are shown with their lines broken as in |
| 1393 |
the source document without requiring |
| 1394 |
.B br |
| 1395 |
requests between lines. |
| 1396 |
. |
| 1397 |
Displays can be kept on a single page or allowed to break across pages. |
| 1398 |
. |
| 1399 |
The |
| 1400 |
.B DS |
| 1401 |
macro begins a kept display of the layout specified in its first |
| 1402 |
argument; |
| 1403 |
non-kept displays are begun with dedicated macros corresponding to their |
| 1404 |
layout. |
| 1405 |
. |
| 1406 |
. |
| 1407 |
.TP |
| 1408 |
.B .DS L |
| 1409 |
.TQ |
| 1410 |
.B .LD |
| 1411 |
Begin |
| 1412 |
.RB ( DS ": kept)" |
| 1413 |
left-aligned display. |
| 1414 |
. |
| 1415 |
. |
| 1416 |
.TP |
| 1417 |
.BR .DS \~\c |
| 1418 |
.RB [ I \~\c |
| 1419 |
.RI [ indent ]] |
| 1420 |
.TQ |
| 1421 |
.BR .ID \~\c |
| 1422 |
.RI [ indent ] |
| 1423 |
Begin |
| 1424 |
.RB ( DS ": kept)" |
| 1425 |
display indented by |
| 1426 |
.I indent |
| 1427 |
if specified, |
| 1428 |
.B \[rs]n[DI] |
| 1429 |
otherwise. |
| 1430 |
. |
| 1431 |
. |
| 1432 |
.TP |
| 1433 |
.B .DS B |
| 1434 |
.TQ |
| 1435 |
.B .BD |
| 1436 |
Begin |
| 1437 |
.RB ( DS ": kept)" |
| 1438 |
block display: |
| 1439 |
the entire display is left-aligned, |
| 1440 |
but indented such that the longest line in the display is centered on |
| 1441 |
the page. |
| 1442 |
. |
| 1443 |
. |
| 1444 |
.TP |
| 1445 |
.B .DS C |
| 1446 |
.TQ |
| 1447 |
.B .CD |
| 1448 |
Begin |
| 1449 |
.RB ( DS ": kept)" |
| 1450 |
centered display: |
| 1451 |
each line in the display is centered. |
| 1452 |
. |
| 1453 |
. |
| 1454 |
.TP |
| 1455 |
.B .DS R |
| 1456 |
.TQ |
| 1457 |
.B .RD |
| 1458 |
Begin |
| 1459 |
.RB ( DS ": kept)" |
| 1460 |
right-aligned display. |
| 1461 |
. |
| 1462 |
This is a GNU extension. |
| 1463 |
. |
| 1464 |
. |
| 1465 |
.TP |
| 1466 |
.B .DE |
| 1467 |
End any display. |
| 1468 |
. |
| 1469 |
. |
| 1470 |
.P |
| 1471 |
.I "groff ms" |
| 1472 |
inserts the distance stored in |
| 1473 |
.B \[rs]n[DD] |
| 1474 |
before and after each pair of display macros; |
| 1475 |
this is a Berkeley extension. |
| 1476 |
. |
| 1477 |
This distance replaces any adjacent inter-paragraph distance |
| 1478 |
or subsequent spacing prior to a section heading. |
| 1479 |
. |
| 1480 |
The |
| 1481 |
.B DI |
| 1482 |
register is a GNU extension; |
| 1483 |
its value is an indentation applied to displays created with |
| 1484 |
.B DS |
| 1485 |
and |
| 1486 |
.B ID |
| 1487 |
without arguments, |
| 1488 |
to |
| 1489 |
.RB \[lq] .DS\~I \[rq] |
| 1490 |
without an indentation argument, |
| 1491 |
and to equations set with |
| 1492 |
.RB \[lq] .EQ\~I \[rq]. |
| 1493 |
. |
| 1494 |
Changes to either register take effect at the next display boundary. |
| 1495 |
. |
| 1496 |
. |
| 1497 |
.\" ==================================================================== |
| 1498 |
.SS "Tables, figures, equations, and references" |
| 1499 |
.\" ==================================================================== |
| 1500 |
. |
| 1501 |
.I ms |
| 1502 |
often sees use with the |
| 1503 |
.IR \%tbl , |
| 1504 |
.IR \%pic , |
| 1505 |
.IR \%eqn , |
| 1506 |
and |
| 1507 |
.I \%refer |
| 1508 |
preprocessors. |
| 1509 |
. |
| 1510 |
.I "groff ms" |
| 1511 |
applies the |
| 1512 |
.B \[rs]n[DD] |
| 1513 |
distance to regions of the document preprocessed with |
| 1514 |
.IR \%eqn , |
| 1515 |
.IR \%pic , |
| 1516 |
and |
| 1517 |
.IR \%tbl . |
| 1518 |
. |
| 1519 |
Mark text meant for preprocessors by enclosing it in pairs of tokens as |
| 1520 |
follows, |
| 1521 |
with nothing between the dot and the macro name. |
| 1522 |
. |
| 1523 |
Preprocessors match these tokens only at the start of an input line. |
| 1524 |
. |
| 1525 |
The formatter interprets them as macro calls. |
| 1526 |
. |
| 1527 |
. |
| 1528 |
.TP |
| 1529 |
.BR .TS " [" H "] |
| 1530 |
.TQ |
| 1531 |
.B .TE |
| 1532 |
Demarcate a table to be processed by the |
| 1533 |
.I tbl |
| 1534 |
preprocessor. |
| 1535 |
. |
| 1536 |
The optional |
| 1537 |
.BR H "\~argument" |
| 1538 |
instructs |
| 1539 |
.I ms |
| 1540 |
to repeat table rows |
| 1541 |
(often column headings) |
| 1542 |
at the top of each new page the table spans, |
| 1543 |
if applicable; |
| 1544 |
calling the |
| 1545 |
.B TH |
| 1546 |
macro marks the end of such rows. |
| 1547 |
. |
| 1548 |
.MR \%tbl 1 |
| 1549 |
provides a comprehensive reference to the preprocessor and offers |
| 1550 |
examples of its use. |
| 1551 |
. |
| 1552 |
. |
| 1553 |
.TP |
| 1554 |
.BI .PS\~ "h v" |
| 1555 |
.TQ |
| 1556 |
.B .PE |
| 1557 |
.TQ |
| 1558 |
.B .PF |
| 1559 |
.B PS |
| 1560 |
marks the start of a |
| 1561 |
.MR \%pic 1 |
| 1562 |
preprocessor |
| 1563 |
diagram; |
| 1564 |
either of |
| 1565 |
.B PE |
| 1566 |
or |
| 1567 |
.B PF |
| 1568 |
ends it, |
| 1569 |
the latter with \[lq]flyback\[rq] to the vertical position at its top. |
| 1570 |
. |
| 1571 |
.I h |
| 1572 |
and |
| 1573 |
.I v |
| 1574 |
are the horizontal and vertical dimensions of the picture; |
| 1575 |
.I pic |
| 1576 |
supplies them automatically. |
| 1577 |
. |
| 1578 |
. |
| 1579 |
.TP |
| 1580 |
.BR .EQ \~[\c |
| 1581 |
.IR align \~[\c |
| 1582 |
.IR label ]] |
| 1583 |
.TQ |
| 1584 |
.B .EN |
| 1585 |
Demarcate mathematics to be processed by the |
| 1586 |
.I \%eqn |
| 1587 |
preprocessor. |
| 1588 |
. |
| 1589 |
.I ms |
| 1590 |
centers the equation by default; |
| 1591 |
.I align |
| 1592 |
can be |
| 1593 |
.BR C , |
| 1594 |
.BR L , |
| 1595 |
.RB or\~ I |
| 1596 |
to (explicitly) center, |
| 1597 |
left-align, |
| 1598 |
or indent it by |
| 1599 |
.BR \[rs]n[DI] , |
| 1600 |
respectively. |
| 1601 |
. |
| 1602 |
.I ms |
| 1603 |
right-aligns any |
| 1604 |
.IR label . |
| 1605 |
. |
| 1606 |
See |
| 1607 |
.MR \%eqn 1 . |
| 1608 |
. |
| 1609 |
. |
| 1610 |
.br |
| 1611 |
.ne 3v |
| 1612 |
.TP |
| 1613 |
.B .[ |
| 1614 |
.TQ |
| 1615 |
.B .] |
| 1616 |
Demarcate a bibliographic citation to be processed by the |
| 1617 |
.I refer |
| 1618 |
preprocessor. |
| 1619 |
. |
| 1620 |
.MR \%refer 1 |
| 1621 |
provides a comprehensive reference to the preprocessor and the format of |
| 1622 |
its bibliographic database. |
| 1623 |
. |
| 1624 |
. |
| 1625 |
.br |
| 1626 |
.ne 2v |
| 1627 |
.P |
| 1628 |
When |
| 1629 |
.I \%refer |
| 1630 |
emits collected references |
| 1631 |
(as might be done on a \[lq]Works Cited\[rq] page), |
| 1632 |
it interpolates the string |
| 1633 |
.B \[rs]*[REFERENCES] |
| 1634 |
as an unnumbered heading |
| 1635 |
.RB ( .SH ). |
| 1636 |
. |
| 1637 |
. |
| 1638 |
.br |
| 1639 |
.ne 2v |
| 1640 |
.P |
| 1641 |
Attempting to place a multi-page table inside a keep can lead to |
| 1642 |
unpleasant results, |
| 1643 |
particularly if the |
| 1644 |
.I tbl \" generic |
| 1645 |
.RB \%\[lq] allbox \[rq] |
| 1646 |
option is used. |
| 1647 |
. |
| 1648 |
. |
| 1649 |
.\" ==================================================================== |
| 1650 |
.SS Footnotes |
| 1651 |
.\" ==================================================================== |
| 1652 |
. |
| 1653 |
A footnote is typically anchored to a place in the text with a |
| 1654 |
.I mark, |
| 1655 |
which is a small integer, |
| 1656 |
a symbol, |
| 1657 |
or arbitrary user-specified text. |
| 1658 |
. |
| 1659 |
. |
| 1660 |
.TP |
| 1661 |
.B \[rs]** |
| 1662 |
Place an |
| 1663 |
.I "automatic number," |
| 1664 |
an automatically generated numeric footnote mark, |
| 1665 |
in the text. |
| 1666 |
. |
| 1667 |
Each time this string is interpolated, |
| 1668 |
the number it produces increments by one. |
| 1669 |
. |
| 1670 |
Automatic numbers start at 1. |
| 1671 |
. |
| 1672 |
This is a Berkeley extension. |
| 1673 |
. |
| 1674 |
. |
| 1675 |
.P |
| 1676 |
Enclose the footnote text in |
| 1677 |
.B FS |
| 1678 |
and |
| 1679 |
.B FE |
| 1680 |
macro calls to set it at the nearest available \[lq]foot\[rq], |
| 1681 |
or bottom, |
| 1682 |
of a text column or page. |
| 1683 |
. |
| 1684 |
. |
| 1685 |
.TP |
| 1686 |
.BR .FS \~[\c |
| 1687 |
.IR mark ] |
| 1688 |
Begin a footnote. |
| 1689 |
. |
| 1690 |
The |
| 1691 |
.B FS\-MARK |
| 1692 |
hook |
| 1693 |
(see below) |
| 1694 |
is called with any supplied |
| 1695 |
.I mark |
| 1696 |
argument, |
| 1697 |
which is then also placed at the beginning of the footnote text. |
| 1698 |
. |
| 1699 |
If |
| 1700 |
.I mark |
| 1701 |
is omitted, |
| 1702 |
the next pending automatic number enqueued by interpolation of the |
| 1703 |
.B * |
| 1704 |
string is used, |
| 1705 |
and if none exists, |
| 1706 |
nothing is prefixed. |
| 1707 |
. |
| 1708 |
. |
| 1709 |
.TP |
| 1710 |
.B .FE |
| 1711 |
End footnote text. |
| 1712 |
. |
| 1713 |
. |
| 1714 |
.P |
| 1715 |
.I groff ms |
| 1716 |
provides a hook macro, |
| 1717 |
.BR FS\-MARK , |
| 1718 |
for user-determined operations to be performed when the |
| 1719 |
.B FS |
| 1720 |
macro is called. |
| 1721 |
. |
| 1722 |
It is passed the same arguments as |
| 1723 |
.B FS |
| 1724 |
itself. |
| 1725 |
. |
| 1726 |
By default, |
| 1727 |
this macro has an empty definition. |
| 1728 |
. |
| 1729 |
.B FS\-MARK |
| 1730 |
is a GNU extension. |
| 1731 |
. |
| 1732 |
. |
| 1733 |
.P |
| 1734 |
Footnote text is formatted as paragraphs are, |
| 1735 |
using analogous parameters. |
| 1736 |
. |
| 1737 |
The registers |
| 1738 |
.BR FI , |
| 1739 |
.BR FPD , |
| 1740 |
.BR FPS , |
| 1741 |
and |
| 1742 |
.B FVS |
| 1743 |
correspond to |
| 1744 |
.BR PI , |
| 1745 |
.BR PD , |
| 1746 |
.BR PS , |
| 1747 |
and |
| 1748 |
.BR VS , |
| 1749 |
respectively; |
| 1750 |
.BR FPD , |
| 1751 |
.BR FPS , |
| 1752 |
and |
| 1753 |
.B FVS |
| 1754 |
are GNU extensions. |
| 1755 |
. |
| 1756 |
. |
| 1757 |
.P |
| 1758 |
The |
| 1759 |
.B FF |
| 1760 |
register controls the formatting of automatically numbered footnote |
| 1761 |
paragraphs, |
| 1762 |
and those for which |
| 1763 |
.B FS |
| 1764 |
is given a |
| 1765 |
.I mark |
| 1766 |
argument, |
| 1767 |
at the bottom of a column or page as follows. |
| 1768 |
. |
| 1769 |
. |
| 1770 |
.RS |
| 1771 |
.TP |
| 1772 |
0 |
| 1773 |
Set an automatic number, |
| 1774 |
or a specified |
| 1775 |
.B FS |
| 1776 |
.I mark |
| 1777 |
argument, |
| 1778 |
as a superscript |
| 1779 |
(on typesetters) |
| 1780 |
or surrounded by square brackets |
| 1781 |
(on terminals). |
| 1782 |
. |
| 1783 |
The footnote paragraph is indented as with |
| 1784 |
.B PP |
| 1785 |
if there is an |
| 1786 |
.B FS |
| 1787 |
argument or an automatic number, |
| 1788 |
and as with |
| 1789 |
.B LP |
| 1790 |
otherwise. |
| 1791 |
. |
| 1792 |
This is the default. |
| 1793 |
. |
| 1794 |
. |
| 1795 |
.TP |
| 1796 |
1 |
| 1797 |
As |
| 1798 |
.BR 0 , |
| 1799 |
but set |
| 1800 |
.I mark |
| 1801 |
as regular text, |
| 1802 |
and follow an automatic number with a period. |
| 1803 |
. |
| 1804 |
. |
| 1805 |
.TP |
| 1806 |
2 |
| 1807 |
As |
| 1808 |
.BR 1 , |
| 1809 |
but without indentation |
| 1810 |
(like |
| 1811 |
.BR LP ). |
| 1812 |
. |
| 1813 |
. |
| 1814 |
.TP |
| 1815 |
3 |
| 1816 |
As |
| 1817 |
.BR 1 , |
| 1818 |
but set the footnote paragraph with |
| 1819 |
.I mark |
| 1820 |
hanging |
| 1821 |
(like |
| 1822 |
.BR IP ). |
| 1823 |
.RE |
| 1824 |
. |
| 1825 |
. |
| 1826 |
.\" ==================================================================== |
| 1827 |
.SS "Language and localization" |
| 1828 |
.\" ==================================================================== |
| 1829 |
. |
| 1830 |
.I groff ms |
| 1831 |
provides several strings that you can customize for your own purposes, |
| 1832 |
or redefine to adapt the macro package to languages other than English. |
| 1833 |
. |
| 1834 |
It is already localized for |
| 1835 |
.\" cs, de, es, fr, it, pl, ru, sv |
| 1836 |
Czech, |
| 1837 |
German, |
| 1838 |
Spanish, |
| 1839 |
French, |
| 1840 |
Italian, |
| 1841 |
Polish, |
| 1842 |
Russian, |
| 1843 |
and |
| 1844 |
Swedish. |
| 1845 |
. |
| 1846 |
Load the desired localization macro package after |
| 1847 |
.IR ms ; |
| 1848 |
see |
| 1849 |
.MR groff_tmac 5 . |
| 1850 |
. |
| 1851 |
. |
| 1852 |
.P |
| 1853 |
.RS |
| 1854 |
.TS |
| 1855 |
cb cb |
| 1856 |
lf(CR) lf(CR). |
| 1857 |
String Default |
| 1858 |
_ |
| 1859 |
\[rs]*[REFERENCES] References |
| 1860 |
\[rs]*[ABSTRACT] \[rs]f[I]ABSTRACT\[rs]f[] |
| 1861 |
\[rs]*[TOC] Table of Contents |
| 1862 |
\[rs]*[MONTH1] January |
| 1863 |
\[rs]*[MONTH2] February |
| 1864 |
\[rs]*[MONTH3] March |
| 1865 |
\[rs]*[MONTH4] April |
| 1866 |
\[rs]*[MONTH5] May |
| 1867 |
\[rs]*[MONTH6] June |
| 1868 |
\[rs]*[MONTH7] July |
| 1869 |
\[rs]*[MONTH8] August |
| 1870 |
\[rs]*[MONTH9] September |
| 1871 |
\[rs]*[MONTH10] October |
| 1872 |
\[rs]*[MONTH11] November |
| 1873 |
\[rs]*[MONTH12] December |
| 1874 |
_ |
| 1875 |
.TE |
| 1876 |
.RE |
| 1877 |
. |
| 1878 |
The default for |
| 1879 |
.B ABSTRACT |
| 1880 |
includes font selection escape sequences to set the word in italics. |
| 1881 |
. |
| 1882 |
. |
| 1883 |
.\" ==================================================================== |
| 1884 |
.SS "Headers and footers" |
| 1885 |
.\" ==================================================================== |
| 1886 |
. |
| 1887 |
There are multiple ways to produce headers and footers. |
| 1888 |
. |
| 1889 |
One is to define the strings |
| 1890 |
.BR LH , |
| 1891 |
.BR CH , |
| 1892 |
and |
| 1893 |
.B RH |
| 1894 |
to set the left, |
| 1895 |
center, |
| 1896 |
and right headers, |
| 1897 |
respectively; |
| 1898 |
and |
| 1899 |
.BR LF , |
| 1900 |
.BR CF , |
| 1901 |
and |
| 1902 |
.B RF |
| 1903 |
to set the left, |
| 1904 |
center, |
| 1905 |
and right footers. |
| 1906 |
. |
| 1907 |
This approach suffices for documents that do not distinguish odd- and |
| 1908 |
even-numbered pages. |
| 1909 |
. |
| 1910 |
. |
| 1911 |
.P |
| 1912 |
Another method is to call macros that set headers or footers for odd- or |
| 1913 |
even-numbered pages. |
| 1914 |
. |
| 1915 |
Each such macro takes a delimited argument separating the left, |
| 1916 |
center, |
| 1917 |
and right header or footer texts from each other. |
| 1918 |
. |
| 1919 |
You can replace the neutral apostrophes (\[aq]) shown below with any |
| 1920 |
character not appearing in the header or footer text. |
| 1921 |
. |
| 1922 |
These macros are Berkeley extensions. |
| 1923 |
. |
| 1924 |
. |
| 1925 |
.br |
| 1926 |
.ne 5v |
| 1927 |
.TP |
| 1928 |
.BR .OH \~\[aq]\c |
| 1929 |
.IR left \[aq] center \[aq] right \[aq] |
| 1930 |
.TQ |
| 1931 |
.BR .OF \~\[aq]\c |
| 1932 |
.IR left \[aq] center \[aq] right \[aq] |
| 1933 |
.TQ |
| 1934 |
.BR .EH \~\[aq]\c |
| 1935 |
.IR left \[aq] center \[aq] right \[aq] |
| 1936 |
.TQ |
| 1937 |
.BR .EF \~\[aq]\c |
| 1938 |
.IR left \[aq] center \[aq] right \[aq] |
| 1939 |
The |
| 1940 |
.B OH |
| 1941 |
and |
| 1942 |
.B EH |
| 1943 |
macros define headers for odd- (recto) and even-numbered (verso) pages, |
| 1944 |
respectively; |
| 1945 |
the |
| 1946 |
.B OF |
| 1947 |
and |
| 1948 |
.B EF |
| 1949 |
macros define footers for them. |
| 1950 |
. |
| 1951 |
. |
| 1952 |
.P |
| 1953 |
With either method, |
| 1954 |
a percent sign |
| 1955 |
.B % |
| 1956 |
in header or footer text is replaced by the current page number. |
| 1957 |
. |
| 1958 |
By default, |
| 1959 |
.I ms |
| 1960 |
places no header on a page numbered \[lq]1\[rq] |
| 1961 |
(regardless of its number format). |
| 1962 |
. |
| 1963 |
. |
| 1964 |
.TP |
| 1965 |
.B .P1 |
| 1966 |
Typeset the header even on page\~1. |
| 1967 |
. |
| 1968 |
To be effective, |
| 1969 |
this macro must be called before the header trap is sprung on any page |
| 1970 |
numbered \[lq]1\[rq]. |
| 1971 |
. |
| 1972 |
This is a Berkeley extension. |
| 1973 |
. |
| 1974 |
. |
| 1975 |
.P |
| 1976 |
For even greater flexibility, |
| 1977 |
.I ms |
| 1978 |
is designed to permit the redefinition of the macros that are called |
| 1979 |
when formatter traps |
| 1980 |
that ordinarily cause the headers and footers to be output are sprung. |
| 1981 |
. |
| 1982 |
.B PT |
| 1983 |
(\[lq]page trap\[rq]) |
| 1984 |
is called by |
| 1985 |
.I ms |
| 1986 |
when the header is to be written, |
| 1987 |
and |
| 1988 |
.B BT |
| 1989 |
(\[lq]bottom trap\[rq]) |
| 1990 |
when the footer is to be. |
| 1991 |
. |
| 1992 |
The |
| 1993 |
.I groff |
| 1994 |
page location trap that |
| 1995 |
.I ms |
| 1996 |
sets up to format the header also calls the |
| 1997 |
(normally undefined) |
| 1998 |
.B HD |
| 1999 |
macro after |
| 2000 |
.BR PT ; |
| 2001 |
you can define |
| 2002 |
.B HD |
| 2003 |
if you need additional processing after setting the header. |
| 2004 |
. |
| 2005 |
.\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper... |
| 2006 |
The |
| 2007 |
.B HD |
| 2008 |
hook is a Berkeley extension. |
| 2009 |
. |
| 2010 |
Any such macros you (re)define must implement any desired specialization |
| 2011 |
for odd-, |
| 2012 |
even-, |
| 2013 |
or first numbered pages. |
| 2014 |
. |
| 2015 |
. |
| 2016 |
.\" ==================================================================== |
| 2017 |
.SS "Tab stops" |
| 2018 |
.\" ==================================================================== |
| 2019 |
. |
| 2020 |
Use the |
| 2021 |
.B ta |
| 2022 |
request to set tab stops as needed. |
| 2023 |
. |
| 2024 |
. |
| 2025 |
.TP |
| 2026 |
.B .TA |
| 2027 |
Reset the tab stops to the |
| 2028 |
.I ms |
| 2029 |
default |
| 2030 |
(every 5 ens). |
| 2031 |
. |
| 2032 |
Redefine this macro to create a different set of default tab stops. |
| 2033 |
. |
| 2034 |
. |
| 2035 |
.\" ==================================================================== |
| 2036 |
.SS Margins |
| 2037 |
.\" ==================================================================== |
| 2038 |
. |
| 2039 |
Control margins using the registers summarized in the \[lq]Margins\[rq] |
| 2040 |
portion of the table in section \[lq]Document control settings\[rq] |
| 2041 |
above. |
| 2042 |
. |
| 2043 |
There is no setting for the right margin; |
| 2044 |
the combination of page offset |
| 2045 |
.B \[rs]n[PO] |
| 2046 |
and line length |
| 2047 |
.B \[rs]n[LL] |
| 2048 |
determines it. |
| 2049 |
. |
| 2050 |
. |
| 2051 |
.\" ==================================================================== |
| 2052 |
.SS "Multiple columns" |
| 2053 |
.\" ==================================================================== |
| 2054 |
. |
| 2055 |
.I ms |
| 2056 |
can set text in as many columns as reasonably fit on the page. |
| 2057 |
. |
| 2058 |
The following macros force a page break if a multi-column layout is |
| 2059 |
active when they are called. |
| 2060 |
. |
| 2061 |
.B \[rs]n[MINGW] |
| 2062 |
is the default minimum gutter width; |
| 2063 |
it is a GNU extension. |
| 2064 |
. |
| 2065 |
When multiple columns are in use, |
| 2066 |
keeps |
| 2067 |
and the |
| 2068 |
.B \%HORPHANS |
| 2069 |
and |
| 2070 |
.B \%PORPHANS |
| 2071 |
registers |
| 2072 |
work with respect to column breaks instead of page breaks. |
| 2073 |
. |
| 2074 |
. |
| 2075 |
.TP |
| 2076 |
.B .1C |
| 2077 |
Arrange page text in a single column |
| 2078 |
(the default). |
| 2079 |
. |
| 2080 |
. |
| 2081 |
.TP |
| 2082 |
.B .2C |
| 2083 |
Arrange page text in two columns. |
| 2084 |
. |
| 2085 |
. |
| 2086 |
.TP |
| 2087 |
.BR .MC \~[\c |
| 2088 |
.IR column-width " [" gutter-width ]] |
| 2089 |
Arrange page text in multiple columns. |
| 2090 |
. |
| 2091 |
If you specify no arguments, |
| 2092 |
it is equivalent to the |
| 2093 |
.B 2C |
| 2094 |
macro. |
| 2095 |
. |
| 2096 |
Otherwise, |
| 2097 |
.I column-width |
| 2098 |
is the width of each column and |
| 2099 |
.I gutter-width |
| 2100 |
is the minimum distance between columns. |
| 2101 |
. |
| 2102 |
. |
| 2103 |
.\" ==================================================================== |
| 2104 |
.SS "Creating a table of contents" |
| 2105 |
.\" ==================================================================== |
| 2106 |
. |
| 2107 |
Define an entry to appear in the table of contents by bracketing its |
| 2108 |
text between calls to the |
| 2109 |
.B XS |
| 2110 |
and |
| 2111 |
.B XE |
| 2112 |
macros. |
| 2113 |
. |
| 2114 |
A typical application is to call them immediately after |
| 2115 |
.B NH |
| 2116 |
or |
| 2117 |
.B SH |
| 2118 |
and repeat the heading text within them. |
| 2119 |
. |
| 2120 |
The |
| 2121 |
.B XA |
| 2122 |
macro, |
| 2123 |
used within |
| 2124 |
.BR XS / XE |
| 2125 |
pairs, |
| 2126 |
supplements an entry\[em]for instance, |
| 2127 |
when it requires multiple output lines, |
| 2128 |
whether because a heading is too long to fit or because style dictates |
| 2129 |
that page numbers not be repeated. |
| 2130 |
. |
| 2131 |
You may wish to indent the text thus wrapped to correspond to its |
| 2132 |
heading depth; |
| 2133 |
this can be done in the entry text by prefixing it with tabs or |
| 2134 |
horizontal motion escape sequences, |
| 2135 |
or by providing a second argument to the |
| 2136 |
.B XA |
| 2137 |
macro. |
| 2138 |
. |
| 2139 |
.B XS |
| 2140 |
and |
| 2141 |
.B XA |
| 2142 |
automatically associate the page number where they are called with the |
| 2143 |
text following them, |
| 2144 |
but they accept arguments to override this behavior. |
| 2145 |
. |
| 2146 |
At the end of the document, |
| 2147 |
call |
| 2148 |
.B TC |
| 2149 |
or |
| 2150 |
.B PX |
| 2151 |
to emit the table of contents; |
| 2152 |
.B TC |
| 2153 |
resets the page number |
| 2154 |
.RB to\~ i |
| 2155 |
(Roman numeral one), |
| 2156 |
and then calls |
| 2157 |
.BR PX . |
| 2158 |
. |
| 2159 |
All of these macros are Berkeley extensions. |
| 2160 |
. |
| 2161 |
. |
| 2162 |
.TP |
| 2163 |
.BR .XS \~[\c |
| 2164 |
.IR page-number ] |
| 2165 |
.TQ |
| 2166 |
.BR .XA \~[\c |
| 2167 |
.IR page-number \~[ indentation ]] |
| 2168 |
.TQ |
| 2169 |
.B .XE |
| 2170 |
Begin, |
| 2171 |
supplement, |
| 2172 |
and end a table of contents entry. |
| 2173 |
. |
| 2174 |
Each entry is associated with |
| 2175 |
.I page-number |
| 2176 |
(otherwise the current page number); |
| 2177 |
a |
| 2178 |
.I page-number |
| 2179 |
of |
| 2180 |
.RB \[lq] no \[rq] |
| 2181 |
prevents a leader and page number from being emitted for that entry. |
| 2182 |
. |
| 2183 |
Use of |
| 2184 |
.B XA |
| 2185 |
within |
| 2186 |
.BR XS / XE |
| 2187 |
is optional; |
| 2188 |
it can be repeated. |
| 2189 |
. |
| 2190 |
If |
| 2191 |
.I indentation |
| 2192 |
is present, |
| 2193 |
a supplemental entry is indented by that amount; |
| 2194 |
ens are assumed if no unit is indicated. |
| 2195 |
. |
| 2196 |
Text on input lines between |
| 2197 |
.B XS |
| 2198 |
and |
| 2199 |
.B XE |
| 2200 |
is stored for later recall by |
| 2201 |
.BR PX . |
| 2202 |
. |
| 2203 |
. |
| 2204 |
.TP |
| 2205 |
.BR .PX \~[ no ] |
| 2206 |
Switch to single-column layout. |
| 2207 |
. |
| 2208 |
Unless |
| 2209 |
.RB \[lq] no \[rq] |
| 2210 |
is specified, |
| 2211 |
center and interpolate |
| 2212 |
.B \[rs]*[TOC] |
| 2213 |
in bold and two points larger than the body text. |
| 2214 |
. |
| 2215 |
Emit the table of contents entries. |
| 2216 |
. |
| 2217 |
. |
| 2218 |
.TP |
| 2219 |
.BR .TC \~[ no ] |
| 2220 |
Set the page number to\~1, |
| 2221 |
the page number format to lowercase Roman numerals, |
| 2222 |
and call |
| 2223 |
.B PX |
| 2224 |
(with a |
| 2225 |
.RB \[lq] no \[rq] |
| 2226 |
argument, |
| 2227 |
if present). |
| 2228 |
. |
| 2229 |
. |
| 2230 |
.P |
| 2231 |
The remaining features in this subsection are GNU extensions. |
| 2232 |
. |
| 2233 |
.I groff ms |
| 2234 |
obviates the need to repeat heading text after |
| 2235 |
.B XS |
| 2236 |
calls. |
| 2237 |
. |
| 2238 |
Call |
| 2239 |
.B XN |
| 2240 |
and |
| 2241 |
.B XH |
| 2242 |
after |
| 2243 |
.B NH |
| 2244 |
and |
| 2245 |
.BR SH , |
| 2246 |
respectively. |
| 2247 |
. |
| 2248 |
Text to be appended to the formatted section heading, |
| 2249 |
but not to appear in the table of contents entry, |
| 2250 |
can follow these calls. |
| 2251 |
. |
| 2252 |
. |
| 2253 |
.TP |
| 2254 |
.BI .XN\~ heading-text |
| 2255 |
Format |
| 2256 |
.I heading-text |
| 2257 |
and create a corresponding table of contents entry; |
| 2258 |
the indentation is computed from the |
| 2259 |
.I depth |
| 2260 |
argument of the preceding |
| 2261 |
.B NH |
| 2262 |
call. |
| 2263 |
. |
| 2264 |
. |
| 2265 |
.TP |
| 2266 |
.BI .XH\~ "depth heading-text" |
| 2267 |
As |
| 2268 |
.BR XN , |
| 2269 |
but use |
| 2270 |
.I depth |
| 2271 |
to determine the indentation. |
| 2272 |
. |
| 2273 |
. |
| 2274 |
.P |
| 2275 |
.I groff ms |
| 2276 |
encourages customization of table of contents entry production. |
| 2277 |
. |
| 2278 |
(Re-)define any of the following macros as desired. |
| 2279 |
. |
| 2280 |
. |
| 2281 |
.TP |
| 2282 |
.BI \%.XN\-REPLACEMENT\~ heading-text |
| 2283 |
.TQ |
| 2284 |
.BI \%.XH\-REPLACEMENT\~ "depth heading-text" |
| 2285 |
These hook macros implement |
| 2286 |
.B XN |
| 2287 |
and |
| 2288 |
.BR XH , |
| 2289 |
and call |
| 2290 |
.B \%XN\-INIT |
| 2291 |
and |
| 2292 |
.BR \%XH\-INIT , |
| 2293 |
respectively, |
| 2294 |
then call |
| 2295 |
.B \%XH\-UPDATE\-TOC |
| 2296 |
with the arguments given them. |
| 2297 |
. |
| 2298 |
. |
| 2299 |
.TP |
| 2300 |
.B \%.XH\-INIT |
| 2301 |
.TQ |
| 2302 |
.B \%.XN\-INIT |
| 2303 |
These hook macros do nothing by default. |
| 2304 |
. |
| 2305 |
. |
| 2306 |
.TP |
| 2307 |
.BI \%.XH\-UPDATE\-TOC\~ "depth heading-text" |
| 2308 |
Bracket |
| 2309 |
.I heading-text |
| 2310 |
with |
| 2311 |
.B XS |
| 2312 |
and |
| 2313 |
.B XE |
| 2314 |
calls, |
| 2315 |
indenting it by 2 ens per level of |
| 2316 |
.I depth |
| 2317 |
beyond the first. |
| 2318 |
. |
| 2319 |
. |
| 2320 |
.P |
| 2321 |
You can customize the style of the leader that bridges each table of |
| 2322 |
contents entry with its page number; |
| 2323 |
define the |
| 2324 |
.B TC\-LEADER |
| 2325 |
special character by using the |
| 2326 |
.B char |
| 2327 |
request. |
| 2328 |
. |
| 2329 |
A typical leader combines the dot glyph |
| 2330 |
.RB \[lq] .\& \[rq] |
| 2331 |
with a horizontal motion escape sequence to spread the dots. |
| 2332 |
. |
| 2333 |
The width of the page number field is stored in the |
| 2334 |
.B TC\-MARGIN |
| 2335 |
register. |
| 2336 |
. |
| 2337 |
. |
| 2338 |
.\" ==================================================================== |
| 2339 |
.SH "Differences from AT&T \f[I]ms\f[]" |
| 2340 |
.\" ==================================================================== |
| 2341 |
. |
| 2342 |
The |
| 2343 |
.I groff ms |
| 2344 |
macros are an independent reimplementation, |
| 2345 |
using no AT&T code. |
| 2346 |
. |
| 2347 |
Since they take advantage of the extended features of |
| 2348 |
.IR groff , |
| 2349 |
they cannot be used with AT&T |
| 2350 |
.IR troff . |
| 2351 |
. |
| 2352 |
.I groff ms |
| 2353 |
supports features described above as Berkeley and |
| 2354 |
Research Tenth Edition Unix extensions, |
| 2355 |
and adds several of its own. |
| 2356 |
. |
| 2357 |
. |
| 2358 |
.IP \[bu] 3n |
| 2359 |
The internals of |
| 2360 |
.I groff ms |
| 2361 |
differ from those of |
| 2362 |
AT&T |
| 2363 |
.IR ms . |
| 2364 |
. |
| 2365 |
Documents that depend upon implementation details of |
| 2366 |
AT&T |
| 2367 |
.I ms |
| 2368 |
may not format properly with |
| 2369 |
.IR "groff ms" . |
| 2370 |
. |
| 2371 |
Such details include macros whose function was not documented in the |
| 2372 |
AT&T |
| 2373 |
.I ms |
| 2374 |
manual |
| 2375 |
(\[lq]Typing Documents on the UNIX System: Using the \-ms Macros with |
| 2376 |
Troff and Nroff\[rq], |
| 2377 |
M.\& E.\& Lesk, |
| 2378 |
Bell Laboratories, |
| 2379 |
1978). |
| 2380 |
.\" TODO: Use refer(1)? |
| 2381 |
.\" XXX: We support RT anyway; maybe we should stop? |
| 2382 |
. |
| 2383 |
. |
| 2384 |
.IP \[bu] |
| 2385 |
The error-handling policy of |
| 2386 |
.I groff ms |
| 2387 |
is to detect and report errors, |
| 2388 |
rather than to ignore them silently. |
| 2389 |
. |
| 2390 |
. |
| 2391 |
.IP \[bu] |
| 2392 |
Research Tenth Edition \" possibly 9th |
| 2393 |
Unix supported |
| 2394 |
.BR P1 / P2 |
| 2395 |
macros to bracket code examples; |
| 2396 |
.I groff ms |
| 2397 |
does not. |
| 2398 |
. |
| 2399 |
. |
| 2400 |
.IP \[bu] |
| 2401 |
.I groff ms |
| 2402 |
does not work in GNU |
| 2403 |
.IR troff 's \" GNU |
| 2404 |
AT&T compatibility mode. |
| 2405 |
. |
| 2406 |
If loaded when that mode is enabled, |
| 2407 |
it aborts processing with a diagnostic message. |
| 2408 |
. |
| 2409 |
. |
| 2410 |
.IP \[bu] |
| 2411 |
Multiple line spacing is not supported. |
| 2412 |
. |
| 2413 |
Use a larger vertical spacing instead. |
| 2414 |
. |
| 2415 |
. |
| 2416 |
.IP \[bu] |
| 2417 |
.I groff ms |
| 2418 |
uses the same header and footer defaults in both |
| 2419 |
.I nroff |
| 2420 |
and |
| 2421 |
.I troff |
| 2422 |
modes |
| 2423 |
as AT&T |
| 2424 |
.I ms |
| 2425 |
does in |
| 2426 |
.I troff |
| 2427 |
mode; |
| 2428 |
AT&T's default in |
| 2429 |
.I nroff |
| 2430 |
mode is to put the date, |
| 2431 |
in U.S.\& traditional format |
| 2432 |
(e.g., |
| 2433 |
\[lq]January 1, 2021\[rq]), |
| 2434 |
in the center footer |
| 2435 |
(the |
| 2436 |
.B CF |
| 2437 |
string). |
| 2438 |
. |
| 2439 |
. |
| 2440 |
.IP \[bu] |
| 2441 |
Many |
| 2442 |
.I groff ms |
| 2443 |
macros, |
| 2444 |
including those for paragraphs, |
| 2445 |
headings, |
| 2446 |
and displays, |
| 2447 |
cause a reset of paragraph rendering parameters, |
| 2448 |
and may change the indentation; |
| 2449 |
they do so not by incrementing or decrementing it, |
| 2450 |
but by setting it absolutely. |
| 2451 |
. |
| 2452 |
This can cause problems for documents that define additional macros of |
| 2453 |
their own that manipulate indentation. |
| 2454 |
. |
| 2455 |
Use |
| 2456 |
.B RS |
| 2457 |
and |
| 2458 |
.B RE |
| 2459 |
instead of the |
| 2460 |
.B in |
| 2461 |
request. |
| 2462 |
. |
| 2463 |
. |
| 2464 |
.IP \[bu] |
| 2465 |
AT&T |
| 2466 |
.I ms |
| 2467 |
interpreted the values of the registers |
| 2468 |
.B PS |
| 2469 |
and |
| 2470 |
.B VS |
| 2471 |
in points, |
| 2472 |
and did not support the use of scaling units with them. |
| 2473 |
. |
| 2474 |
.I groff ms |
| 2475 |
interprets values of the registers |
| 2476 |
.BR PS , |
| 2477 |
.BR VS , |
| 2478 |
.BR FPS , |
| 2479 |
and |
| 2480 |
.BR FVS , |
| 2481 |
equal to or larger than\~1,000 |
| 2482 |
(one thousand) |
| 2483 |
as decimal fractions multiplied by\~1,000. |
| 2484 |
. |
| 2485 |
(Register values are converted to and stored as basic |
| 2486 |
units. |
| 2487 |
. |
| 2488 |
See \[lq]Measurements\[rq] in the |
| 2489 |
.I groff |
| 2490 |
Texinfo manual or in |
| 2491 |
.MR groff 7 ). |
| 2492 |
. |
| 2493 |
This threshold makes use of a scaling unit with these parameters |
| 2494 |
practical for high-resolution devices while preserving backward |
| 2495 |
compatibility. |
| 2496 |
. |
| 2497 |
It also permits expression of non-integral type sizes. |
| 2498 |
. |
| 2499 |
For example, |
| 2500 |
.RB \[lq] "groff \-rPS=10.5p" \[rq] |
| 2501 |
at the shell prompt is equivalent to placing |
| 2502 |
.RB \[lq] ".nr PS 10.5p" \[rq] |
| 2503 |
at the beginning of the document. |
| 2504 |
.\" Note to document maintainers: |
| 2505 |
.\" |
| 2506 |
.\" We use the integral point scaling unit `p` instead of the |
| 2507 |
.\" typographical point `z` because this is a register assignment; the |
| 2508 |
.\" value gets converted to scaled points automatically. |
| 2509 |
.\" Observe: |
| 2510 |
.\" $ printf '.nr PS 10.5p\n.pnr PS\n' | groff # 1.24 or later |
| 2511 |
.\" PS 10500 +0 0 |
| 2512 |
.\" |
| 2513 |
.\" groff ms users can thus remain innocent of the z unit if they like. |
| 2514 |
. |
| 2515 |
. |
| 2516 |
.IP \[bu] |
| 2517 |
AT&T |
| 2518 |
.IR ms 's |
| 2519 |
.B AU |
| 2520 |
macro supported arguments |
| 2521 |
whose values were used with some |
| 2522 |
.RB non- RP |
| 2523 |
document types; |
| 2524 |
that of |
| 2525 |
.I "groff ms" |
| 2526 |
does not. |
| 2527 |
. |
| 2528 |
. |
| 2529 |
.IP \[bu] |
| 2530 |
Right-aligned displays are available. |
| 2531 |
. |
| 2532 |
The AT&T |
| 2533 |
.I ms |
| 2534 |
manual observes that \[lq]it is tempting to assume that |
| 2535 |
.RB \[lq] ".DS R" \[rq] |
| 2536 |
will right adjust lines, |
| 2537 |
but it doesn't work\[rq]. |
| 2538 |
. |
| 2539 |
In |
| 2540 |
.IR "groff ms" , |
| 2541 |
it does. |
| 2542 |
. |
| 2543 |
. |
| 2544 |
.IP \[bu] |
| 2545 |
To make |
| 2546 |
.I groff ms |
| 2547 |
use the default page offset |
| 2548 |
(which also specifies the left margin), |
| 2549 |
the |
| 2550 |
.B PO |
| 2551 |
register must stay undefined until the first |
| 2552 |
.I ms |
| 2553 |
macro is called. |
| 2554 |
. |
| 2555 |
This implies that |
| 2556 |
.B \[rs]n[PO] |
| 2557 |
should not be used early in the document, |
| 2558 |
unless it is changed also: |
| 2559 |
accessing an undefined register automatically defines it. |
| 2560 |
. |
| 2561 |
. |
| 2562 |
.IP \[bu] |
| 2563 |
.I groff ms |
| 2564 |
supports the |
| 2565 |
.B PN |
| 2566 |
register, |
| 2567 |
but it is not necessary; |
| 2568 |
you can access the page number via the usual |
| 2569 |
.B % |
| 2570 |
register and invoke the |
| 2571 |
.B af |
| 2572 |
request to assign a different format to it if desired. |
| 2573 |
. |
| 2574 |
(If you redefine the |
| 2575 |
.I ms |
| 2576 |
.B PT |
| 2577 |
macro \" I wouldn't mention that, but Lesk 1978 encourages doing so. :-/ |
| 2578 |
and desire special treatment of certain page numbers\[em]like |
| 2579 |
.RB \[lq] 1 \[rq]\[em]you |
| 2580 |
may need to handle a non-Arabic page number format, |
| 2581 |
as |
| 2582 |
.IR "groff ms" 's |
| 2583 |
.B PT |
| 2584 |
does; |
| 2585 |
see the macro package source. |
| 2586 |
. |
| 2587 |
.I groff ms |
| 2588 |
aliases the |
| 2589 |
.B PN |
| 2590 |
register to |
| 2591 |
.BR % .) |
| 2592 |
. |
| 2593 |
. |
| 2594 |
.IP \[bu] |
| 2595 |
The AT&T |
| 2596 |
.I ms |
| 2597 |
manual documents registers |
| 2598 |
.B CW |
| 2599 |
and |
| 2600 |
.B GW |
| 2601 |
as setting the default column width and \[lq]intercolumn gap\[rq], |
| 2602 |
respectively, |
| 2603 |
and which applied when |
| 2604 |
.B MC |
| 2605 |
was called with fewer than two arguments. |
| 2606 |
. |
| 2607 |
.I groff ms |
| 2608 |
instead treats |
| 2609 |
.B MC |
| 2610 |
without arguments as synonymous with |
| 2611 |
.BR 2C ; |
| 2612 |
there is thus no occasion for a default column width register. |
| 2613 |
. |
| 2614 |
Further, |
| 2615 |
the |
| 2616 |
.B MINGW |
| 2617 |
register |
| 2618 |
and the second argument to |
| 2619 |
.B MC |
| 2620 |
specify a |
| 2621 |
.I minimum |
| 2622 |
space between columns, |
| 2623 |
not the fixed gutter width of AT&T |
| 2624 |
.IR ms . |
| 2625 |
. |
| 2626 |
. |
| 2627 |
.IP \[bu] |
| 2628 |
The AT&T |
| 2629 |
.I ms |
| 2630 |
manual did not document the |
| 2631 |
.B QI |
| 2632 |
register; |
| 2633 |
Berkeley and |
| 2634 |
.I "groff ms" |
| 2635 |
do. |
| 2636 |
. |
| 2637 |
. |
| 2638 |
.IP \[bu] |
| 2639 |
.I "groff ms" |
| 2640 |
sets the register |
| 2641 |
.B GS |
| 2642 |
to\~1; |
| 2643 |
the AT&T |
| 2644 |
.I ms |
| 2645 |
package does not use it. |
| 2646 |
. |
| 2647 |
A document can test its value to determine whether it is being formatted |
| 2648 |
with |
| 2649 |
.I "groff ms" |
| 2650 |
or another implementation. |
| 2651 |
. |
| 2652 |
. |
| 2653 |
.\" ==================================================================== |
| 2654 |
.SS "Unix Version\~7 macros unimplemented by \f[I]groff ms\f[]" |
| 2655 |
.\" ==================================================================== |
| 2656 |
. |
| 2657 |
Several macros described in the Unix Version\~7 |
| 2658 |
.I ms |
| 2659 |
documentation are unimplemented by |
| 2660 |
.I groff ms |
| 2661 |
because they are specific to the requirements of documents produced |
| 2662 |
internally by Bell Laboratories, |
| 2663 |
some of which also require a glyph for the Bell System logo that |
| 2664 |
.I groff |
| 2665 |
does not support. |
| 2666 |
. |
| 2667 |
These macros implemented several document type formats |
| 2668 |
(\c |
| 2669 |
.BR EG , \" engineer's notes |
| 2670 |
.BR IM , \" internal memorandum |
| 2671 |
.BR MF , \" memorandum for file |
| 2672 |
.BR MR , \" memorandum for record |
| 2673 |
.BR TM , \" technical memorandum |
| 2674 |
.BR TR ), \" technical report |
| 2675 |
were meaningful only in conjunction with the use of certain document |
| 2676 |
types |
| 2677 |
(\c |
| 2678 |
.BR AT , \" attachments |
| 2679 |
.BR CS , \" cover sheet info for `TM` documents |
| 2680 |
.BR CT , \" copies to |
| 2681 |
.BR OK , \" "other keywords" for `TM` documents |
| 2682 |
.BR SG ), \" signatures for `TM` documents |
| 2683 |
stored the postal addresses of Bell Labs sites |
| 2684 |
(\c |
| 2685 |
.BR HO , \" Holmdel |
| 2686 |
.BR IH , \" Naperville |
| 2687 |
.BR MH , \" Murray Hill |
| 2688 |
.BR PY , \" Piscataway |
| 2689 |
.BR WH ), \" Whippany |
| 2690 |
or lacked a stable definition over time |
| 2691 |
(\c |
| 2692 |
.BR UX ). \" Unix; on 1st use, add footnote identifying trademark owner |
| 2693 |
. |
| 2694 |
. |
| 2695 |
.\" ==================================================================== |
| 2696 |
.SH "Legacy features" |
| 2697 |
.\" ==================================================================== |
| 2698 |
. |
| 2699 |
.I "groff ms" |
| 2700 |
retains some legacy features solely to support formatting of historical |
| 2701 |
documents; |
| 2702 |
contemporary ones should not use them because they can render poorly. |
| 2703 |
. |
| 2704 |
See |
| 2705 |
.MR groff_char 7 |
| 2706 |
instead. |
| 2707 |
. |
| 2708 |
. |
| 2709 |
.\" ==================================================================== |
| 2710 |
.SS "AT&T \f[I]ms\f[] accent mark strings" |
| 2711 |
.\" ==================================================================== |
| 2712 |
. |
| 2713 |
AT&T |
| 2714 |
.I ms |
| 2715 |
defined |
| 2716 |
accent mark strings as follows. |
| 2717 |
. |
| 2718 |
. |
| 2719 |
.P |
| 2720 |
.TS |
| 2721 |
Cb Lb |
| 2722 |
Lf(CR) L. |
| 2723 |
String Description |
| 2724 |
_ |
| 2725 |
\[rs]*[\[aq]] Apply acute accent to subsequent glyph. |
| 2726 |
\[rs]*[\[ga]] Apply grave accent to subsequent glyph. |
| 2727 |
\[rs]*[:] Apply dieresis (umlaut) to subsequent glyph. |
| 2728 |
\[rs]*[\[ha]] Apply circumflex accent to subsequent glyph. |
| 2729 |
\[rs]*[\[ti]] Apply tilde accent to subsequent glyph. |
| 2730 |
\[rs]*[C] Apply caron to subsequent glyph. |
| 2731 |
.\" \*v was an undocumented (in Lesk 1978-11-13) synonym for \*C. |
| 2732 |
\[rs]*[,] Apply cedilla to subsequent glyph. |
| 2733 |
.TE |
| 2734 |
. |
| 2735 |
. |
| 2736 |
.\" ==================================================================== |
| 2737 |
.SS "Berkeley \f[I]ms\f[] accent mark and glyph strings" |
| 2738 |
.\" ==================================================================== |
| 2739 |
. |
| 2740 |
Berkeley |
| 2741 |
.I ms |
| 2742 |
offered an |
| 2743 |
.B AM |
| 2744 |
macro; |
| 2745 |
calling it redefined the AT&T accent mark strings |
| 2746 |
(except for |
| 2747 |
.BR \[rs]*C ), |
| 2748 |
applied them to the |
| 2749 |
.I preceding |
| 2750 |
glyph, |
| 2751 |
and defined additional strings, |
| 2752 |
some for spacing glyphs. |
| 2753 |
. |
| 2754 |
. |
| 2755 |
.TP |
| 2756 |
.B .AM |
| 2757 |
Enable alternative accent mark and glyph-producing strings. |
| 2758 |
. |
| 2759 |
. |
| 2760 |
.P |
| 2761 |
.TS |
| 2762 |
Cb Lb |
| 2763 |
Lf(CR) L. |
| 2764 |
String Description |
| 2765 |
_ |
| 2766 |
\[rs]*[\[aq]] Apply acute accent to preceding glyph. |
| 2767 |
\[rs]*[\[ga]] Apply grave accent to preceding glyph. |
| 2768 |
\[rs]*[:] Apply dieresis (umlaut) to preceding glyph. |
| 2769 |
\[rs]*[\[ha]] Apply circumflex accent to preceding glyph. |
| 2770 |
\[rs]*[\[ti]] Apply tilde accent to preceding glyph. |
| 2771 |
\[rs]*[,] Apply cedilla to preceding glyph. |
| 2772 |
\[rs]*[/] Apply stroke (slash) to preceding glyph. |
| 2773 |
\[rs]*[v] Apply caron to preceding glyph. |
| 2774 |
\[rs]*[_] Apply macron to preceding glyph. |
| 2775 |
\[rs]*[.] Apply underdot to preceding glyph. |
| 2776 |
\[rs]*[o] Apply ring accent to preceding glyph. |
| 2777 |
_ |
| 2778 |
\[rs]*[?] Interpolate inverted question mark. |
| 2779 |
\[rs]*[!] Interpolate inverted exclamation mark. |
| 2780 |
\[rs]*[8] Interpolate small letter sharp s. |
| 2781 |
\[rs]*[q] Interpolate small letter o with hook accent (ogonek). |
| 2782 |
\[rs]*[3] Interpolate small letter yogh. |
| 2783 |
\[rs]*[d\-] Interpolate small letter eth. |
| 2784 |
\[rs]*[D\-] Interpolate capital letter eth. |
| 2785 |
\[rs]*[th] Interpolate small letter thorn. |
| 2786 |
\[rs]*[TH] Interpolate capital letter thorn. |
| 2787 |
\[rs]*[ae] Interpolate small ae ligature. |
| 2788 |
\[rs]*[AE] Interpolate capital ae ligature. |
| 2789 |
\[rs]*[oe] Interpolate small oe ligature. |
| 2790 |
\[rs]*[OE] Interpolate capital oe ligature. |
| 2791 |
.TE |
| 2792 |
. |
| 2793 |
. |
| 2794 |
.\" ==================================================================== |
| 2795 |
.SH "Naming conventions" |
| 2796 |
.\" ==================================================================== |
| 2797 |
. |
| 2798 |
External names available to documents that use the |
| 2799 |
.I "groff ms" |
| 2800 |
macros contain only uppercase letters and digits. |
| 2801 |
. |
| 2802 |
The package reserves for internal use the following identifiers: |
| 2803 |
. |
| 2804 |
. |
| 2805 |
.IP \[bu] 3n |
| 2806 |
those containing the characters |
| 2807 |
.BR * , |
| 2808 |
.BR @ , |
| 2809 |
and\~\c |
| 2810 |
.BR : ; |
| 2811 |
and |
| 2812 |
. |
| 2813 |
. |
| 2814 |
.IP \[bu] |
| 2815 |
those containing only uppercase letters and digits. |
| 2816 |
. |
| 2817 |
. |
| 2818 |
.P |
| 2819 |
When selecting a name for your document's own macros, |
| 2820 |
strings, |
| 2821 |
and |
| 2822 |
registers, |
| 2823 |
avoid those reserved by |
| 2824 |
.I "groff ms" |
| 2825 |
and those defined by |
| 2826 |
GNU |
| 2827 |
.IR troff .\" GNU |
| 2828 |
See |
| 2829 |
.MR groff 7 |
| 2830 |
for complete lists thereof. |
| 2831 |
. |
| 2832 |
. |
| 2833 |
.P |
| 2834 |
.I "groff ms" |
| 2835 |
organizes most of its internal names into modules. |
| 2836 |
. |
| 2837 |
The naming convenion is as follows. |
| 2838 |
. |
| 2839 |
. |
| 2840 |
.IP \[bu] 3n |
| 2841 |
Names used only within one module are of the form |
| 2842 |
.IB \%module * name\c |
| 2843 |
\&. |
| 2844 |
. |
| 2845 |
. |
| 2846 |
.IP \[bu] |
| 2847 |
Names used outside the module in which they are defined are of the form |
| 2848 |
.IB \%module @ name\c |
| 2849 |
\&. |
| 2850 |
. |
| 2851 |
. |
| 2852 |
.IP \[bu] |
| 2853 |
Names associated with a particular environment are of the form |
| 2854 |
.IB \%environment : name\c |
| 2855 |
\&; |
| 2856 |
these are used only within the |
| 2857 |
.B par |
| 2858 |
module. |
| 2859 |
. |
| 2860 |
. |
| 2861 |
.IP \[bu] |
| 2862 |
.I name |
| 2863 |
does not have a module prefix. |
| 2864 |
. |
| 2865 |
. |
| 2866 |
.IP \[bu] |
| 2867 |
Names constructed to implement arrays are of the form |
| 2868 |
.IB \%array ! index\c |
| 2869 |
\&. |
| 2870 |
. |
| 2871 |
. |
| 2872 |
.\" ==================================================================== |
| 2873 |
.SH Files |
| 2874 |
.\" ==================================================================== |
| 2875 |
. |
| 2876 |
.TP |
| 2877 |
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:\%s\:.tmac |
| 2878 |
implements the package. |
| 2879 |
. |
| 2880 |
. |
| 2881 |
.TP |
| 2882 |
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/refer\-ms.tmac |
| 2883 |
implements |
| 2884 |
.MR \%refer 1 |
| 2885 |
support for |
| 2886 |
.IR ms . |
| 2887 |
. |
| 2888 |
. |
| 2889 |
.TP |
| 2890 |
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:ms\:.tmac |
| 2891 |
is a wrapper enabling the package to be loaded with the option |
| 2892 |
.RB \[lq] "\-m ms" \[rq]. |
| 2893 |
. |
| 2894 |
. |
| 2895 |
. |
| 2896 |
.\" ==================================================================== |
| 2897 |
.SH Authors |
| 2898 |
.\" ==================================================================== |
| 2899 |
. |
| 2900 |
The GNU version of the |
| 2901 |
.I ms |
| 2902 |
macro package was written by James Clark and contributors. |
| 2903 |
. |
| 2904 |
This document was written by Clark, |
| 2905 |
.MT lkollar@\:despammed\:.com |
| 2906 |
Larry Kollar |
| 2907 |
.ME , |
| 2908 |
and |
| 2909 |
.MT g.branden\:.robinson@\:gmail\:.com |
| 2910 |
G.\& Branden Robinson |
| 2911 |
.ME . |
| 2912 |
. |
| 2913 |
. |
| 2914 |
.br |
| 2915 |
.ne 8v |
| 2916 |
.\" ==================================================================== |
| 2917 |
.SH "See also" |
| 2918 |
.\" ==================================================================== |
| 2919 |
. |
| 2920 |
A manual is available in source and rendered form. |
| 2921 |
. |
| 2922 |
On your system, |
| 2923 |
it may be compressed and/or available in additional formats. |
| 2924 |
. |
| 2925 |
. |
| 2926 |
.TP |
| 2927 |
.I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:ms\:.ms |
| 2928 |
.TQ |
| 2929 |
.I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:ms\:.ps |
| 2930 |
\[lq]Using |
| 2931 |
.I groff |
| 2932 |
with the |
| 2933 |
.I ms |
| 2934 |
Macro Package\[rq]; |
| 2935 |
Larry Kollar and \%G.\~Branden Robinson. |
| 2936 |
. |
| 2937 |
. |
| 2938 |
.br |
| 2939 |
.ne 5v |
| 2940 |
.TP |
| 2941 |
.I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%msboxes\:.ms |
| 2942 |
.TQ |
| 2943 |
.I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%msboxes\:.pdf |
| 2944 |
\[lq]Using PDF boxes with |
| 2945 |
.I groff |
| 2946 |
and the |
| 2947 |
.I ms |
| 2948 |
macros\[rq]; |
| 2949 |
Deri James. |
| 2950 |
. |
| 2951 |
.B \%BOXSTART |
| 2952 |
and |
| 2953 |
.B \%BOXSTOP |
| 2954 |
macros are available via the |
| 2955 |
.I sboxes |
| 2956 |
extension package, |
| 2957 |
enabling colored, |
| 2958 |
bordered boxes when the |
| 2959 |
.B pdf |
| 2960 |
output device is used. |
| 2961 |
. |
| 2962 |
. |
| 2963 |
.PP |
| 2964 |
.IR "Groff: The GNU Implementation of troff" , |
| 2965 |
by Trent A.\& Fisher and Werner Lemberg, |
| 2966 |
is the primary |
| 2967 |
.I groff |
| 2968 |
manual. |
| 2969 |
. |
| 2970 |
You can browse it interactively with \[lq]info groff\[rq]. |
| 2971 |
. |
| 2972 |
. |
| 2973 |
.PP |
| 2974 |
.MR groff 1 , |
| 2975 |
.MR \%troff 1 , |
| 2976 |
.MR \%tbl 1 , |
| 2977 |
.MR \%pic 1 , |
| 2978 |
.MR \%eqn 1 , |
| 2979 |
.MR \%refer 1 |
| 2980 |
. |
| 2981 |
. |
| 2982 |
.\" Restore compatibility mode (for, e.g., Solaris 10/11). |
| 2983 |
.cp \n[*groff_groff_ms_7_man_C] |
| 2984 |
.do rr *groff_groff_ms_7_man_C |
| 2985 |
. |
| 2986 |
. |
| 2987 |
.\" Local Variables: |
| 2988 |
.\" fill-column: 72 |
| 2989 |
.\" mode: nroff |
| 2990 |
.\" End: |
| 2991 |
.\" vim: set filetype=groff textwidth=72: |