tmac/groff_ms.man

   1 '\" t
   2 .ig
   3 Copyright (C) 1989-1995, 2001, 2002, 2003 Free Software Foundation, Inc.
   4
   5 Permission is granted to make and distribute verbatim copies of
   6 this manual provided the copyright notice and this permission notice
   7 are preserved on all copies.
   8
   9 Permission is granted to copy and distribute modified versions of this
  10 manual under the conditions for verbatim copying, provided that the
  11 entire resulting derived work is distributed under the terms of a
  12 permission notice identical to this one.
  13
  14 Permission is granted to copy and distribute translations of this
  15 manual into another language, under the above conditions for modified
  16 versions, except that this permission notice may be included in
  17 translations approved by the Free Software Foundation instead of in
  18 the original English.
  19 ..
  20 .TH GROFF_MS @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
  21 .SH NAME
  22 groff_ms \- groff ms macros
  23 .SH SYNOPSIS
  24 .B groff
  25 .B \-ms
  26 [
  27 .IR options .\|.\|.\&
  28 ]
  29 [
  30 .IR files .\|.\|.\&
  31 ]
  32 .br
  33 .B groff
  34 .B \-m\ ms
  35 [
  36 .IR options .\|.\|.\&
  37 ]
  38 [
  39 .IR files .\|.\|.\&
  40 ]
  41 .\" -----
  42 .SH DESCRIPTION
  43 This manual page describes the GNU version of the
  44 .I ms
  45 macros,
  46 part of the
  47 .I groff
  48 typesetting system.
  49 The
  50 .I ms
  51 macros are mostly compatible with the
  52 documented behavior of the 4.3
  53 .SM BSD
  54 Unix
  55 .I ms
  56 macros (see
  57 .I Differences from troff ms
  58 below for details).
  59 The
  60 .I ms
  61 macros are suitable for reports, letters, books, and
  62 technical documentation.
  63 .\" -----
  64 .SH USAGE
  65 The
  66 .I ms
  67 macro package expects files to have
  68 a certain amount of structure.
  69 The simplest documents can begin with a paragraph macro
  70 and consist of text separated by paragraph macros
  71 or even blank lines.
  72 Longer documents have a structure as follows:
  73 .TP
  74 .B "Document type"
  75 If you use the
  76 .B RP
  77 (report) macro at the beginning of the document,
  78 .I groff
  79 prints the cover page information on its own page;
  80 otherwise it prints the information on the
  81 first page with your document text immediately following.
  82 Other document formats found in AT&T
  83 .I troff
  84 are specific to AT&T
  85 or Berkeley, and are not supported in
  86 .IR "groff ms" .
  87 .TP
  88 .B "Format and layout"
  89 By setting number registers,
  90 you can change your document's type (font and size),
  91 margins, spacing, headers and footers, and footnotes.
  92 See
  93 .I "Document control registers"
  94 below for more details.
  95 .TP
  96 .B "Cover page"
  97 A cover page consists of a title,
  98 and optionally the author's name and institution,
  99 an abstract, and the date.
 100 See
 101 .I "Cover page macros"
 102 below for more details.
 103 .TP
 104 .B "Body"
 105 Following the cover page is your document.
 106 It consists of paragraphs, headings, and lists.
 107 .TP
 108 .B "Table of contents"
 109 Longer documents usually include a table of contents,
 110 which you can add by placing the
 111 .B TC
 112 macro at the end of your document.
 113 .\" -----
 114 .SS "Document control registers"
 115 The following table lists the document control
 116 number registers.
 117 For the sake of consistency,
 118 set registers related to margins at the beginning of your document,
 119 or just after the
 120 .B RP
 121 macro.
 122 .LP
 123 .ne 9
 124 .B Margin settings
 125 .RS
 126 .na
 127 .TS
 128 cb   s cb s s cb s cb s
 129 afCW s l  s s l  s l  s.
 130 Reg.    Definition      Effective       Default
 131 _
 132 PO      T{
 133 Page offset (left margin)
 134 T}      T{
 135 next page
 136 T}      1i
 137 LL      T{
 138 Line length
 139 T}      next para.      6i
 140 LT      T{
 141 Header/footer length
 142 T}      next para.      6i
 143 HM      T{
 144 Top (header) margin
 145 T}      next page       1i
 146 FM      T{
 147 Bottom (footer) margin
 148 T}      next page       1i
 149 _
 150 .TE
 151 .RE
 152 .LP
 153 .ne 7
 154 .B Text settings
 155 .RS
 156 .TS
 157 cb   s cb s s cb s cb s
 158 afCW s l  s s l  s l  s.
 159 Reg.    Definition      Effective       Default
 160 _
 161 PS      T{
 162 Point size
 163 T}      next para.      10p
 164 VS      T{
 165 Line spacing (leading)
 166 T}      next para.      12p
 167 _
 168 .TE
 169 .RE
 170 .LP
 171 .ne 7
 172 .B Paragraph settings
 173 .RS
 174 .TS
 175 cb cb s cb cb
 176 afCW l s l l .
 177 Reg.    Definition      Effective       Default
 178 _
 179 PI      T{
 180 Initial indent
 181 T}      next para.      5n
 182 PD      T{
 183 Space between paragraphs
 184 T}      next para.      0.3v
 185 QI      T{
 186 Quoted paragraph indent
 187 T}      next para.      5n
 188 _
 189 .TE
 190 .RE
 191 .LP
 192 .ne 7
 193 .B Footnote settings
 194 .RS
 195 .TS
 196 cb cb cb cb
 197 afCW l l l .
 198 Reg.    Definition      Effective       Default
 199 _
 200 FL      Footnote length next footnote   \[rs]n[LL]*5/6
 201 FI      Footnote indent next footnote   2n
 202 FF      Footnote format next footnote   0
 203 FPS     Point size      next footnote   \[rs]n[PS]-2
 204 FVS     Vert. spacing   next footnote   \[rs]n[FPS]+2
 205 FPD     Para. spacing   next footnote   \[rs]n[PD]/2
 206 _
 207 .TE
 208 .RE
 209 .LP
 210 .ne 6
 211 .B Other settings
 212 .RS
 213 .TS
 214 cb   s cb s s cb s cb s
 215 afCW s l  s s l  s l  s.
 216 Reg.    Definition      Effective       Default
 217 _
 218 MINGW   T{
 219 Minimum width between columns
 220 T}      next page       2n
 221 _
 222 .TE
 223 .ad
 224 .RE
 225 .\" -----
 226 .SS "Cover page macros"
 227 Use the following macros to create a cover page for your document
 228 in the order shown.
 229 .TP
 230 .B \&.RP [no]
 231 Specifies the report format for your document.
 232 The report format creates a separate cover page.
 233 With no
 234 .B RP
 235 macro,
 236 .I groff
 237 prints a subset of the
 238 cover page on page\~1 of your document.
 239 .IP
 240 If you use the optional
 241 .B no
 242 argument,
 243 .I groff
 244 prints a title page but
 245 does not repeat any of the title page information
 246 (title, author, abstract, etc.\&)
 247 on page\~1 of the document.
 248 .TP
 249 .B \&.P1
 250 (P-one) Prints the header on page\~1.
 251 The default is to suppress the header.
 252 .TP
 253 .BI "\&.DA [" xxx ]
 254 (optional) Print the current date,
 255 or the arguments to the macro if any,
 256 on the title page (if specified)
 257 and in the footers.
 258 This is the default for
 259 .IR nroff .
 260 .TP
 261 .BI "\&.ND [" xxx ]
 262 (optional) Print the current date,
 263 or the arguments to the macro if any,
 264 on the title page (if specified)
 265 but not in the footers.
 266 This is the default for
 267 .IR troff .
 268 .TP
 269 .B \&.TL
 270 Specifies the document title.
 271 .I Groff
 272 collects text following the
 273 .B TL
 274 macro into the title, until reaching the author name or abstract.
 275 .TP
 276 .B \&.AU
 277 Specifies the author's name.
 278 You can specify multiple authors by using an
 279 .B AU
 280 macro for each author.
 281 .TP
 282 .B \&.AI
 283 Specifies the author's institution.
 284 You can specify multiple institutions.
 285 .TP
 286 .B \&.AB [no]
 287 Begins the abstract.
 288 The default is to print the word
 289 .BR ABSTRACT ,
 290 centered and in italics, above the text of the abstract.
 291 The option
 292 .B no
 293 suppresses this heading.
 294 .TP
 295 .B \&.AE
 296 End the abstract.
 297 .\" -----
 298 .SS Paragraphs
 299 Use the
 300 .B PP
 301 macro to create indented paragraphs,
 302 and the
 303 .B LP
 304 macro to create paragraphs with no initial indent.
 305 .PP
 306 The
 307 .B QP
 308 macro indents all text at both left and right margins.
 309 The effect is identical to the HTML
 310 .B <BLOCKQUOTE>
 311 element.
 312 The next paragraph or heading
 313 returns margins to normal.
 314 .PP
 315 The
 316 .B XP
 317 macro produces an exdented paragraph.
 318 The first line of the paragraph begins at
 319 the left margin,
 320 and subsequent lines are indented
 321 (the opposite of
 322 .BR PP ).
 323 .SS Headings
 324 Use headings to create a hierarchical structure
 325 for your document.
 326 The
 327 .I ms
 328 macros print headings in
 329 .B bold
 330 using the same font family and point size as the body text.
 331 .PP
 332 The following heading macros are available:
 333 .TP
 334 .BI \&.NH \0xx
 335 Numbered heading.
 336 The argument
 337 .I xx
 338 is either a numeric argument to indicate the
 339 level of the heading, or
 340 .I S\ xx\ xx\ \c
 341 ".\|.\|."
 342 to set the section number explicitly.
 343 If you specify heading levels out of sequence,
 344 such as invoking
 345 .B ".NH\ 3"
 346 after
 347 .BR ".NH\ 1" ,
 348 .I groff
 349 prints a warning on standard error.
 350 .TP
 351 .B \&.SH
 352 Unnumbered subheading.
 353 .\" -----
 354 .SS Highlighting
 355 The
 356 .I ms
 357 macros provide a variety of methods to highlight
 358 or emphasize text:
 359 .TP
 360 .BI "\&.B [" txt " [" post " [" pre ]]]
 361 Sets its first argument in
 362 .BR "bold type" .
 363 If you specify a second argument,
 364 .I groff
 365 prints it in the previous font after
 366 the bold text, with no intervening space
 367 (this allows you to set punctuation after
 368 the highlighted text without highlighting
 369 the punctuation).
 370 Similarly, it prints the third argument (if any)
 371 in the previous font
 372 .B before
 373 the first argument.
 374 For example,
 375 .RS
 376 .IP
 377 \&.B foo ) (
 378 .RE
 379 .IP
 380 prints
 381 .RB ( foo ).
 382 .IP
 383 If you give this macro no arguments,
 384 .I groff
 385 prints all text following in bold until
 386 the next highlighting, paragraph, or heading macro.
 387 .TP
 388 .BI "\&.R [" txt " [" post " [" pre ]]]
 389 Sets its first argument in
 390 roman (or regular) type.
 391 It operates similarly to the
 392 .B B
 393 macro otherwise.
 394 .TP
 395 .BI "\&.I [" txt " [" post " [" pre ]]]
 396 Sets its first argument in
 397 .IR "italic type" .
 398 It operates similarly to the
 399 .B B
 400 macro otherwise.
 401 .TP
 402 .BI "\&.CW [" txt " [" post " [" pre ]]]
 403 Sets its first argument in a constant width face.
 404 It operates similarly to the
 405 .B B
 406 macro otherwise.
 407 .TP
 408 .BI "\&.BI [" txt " [" post " [" pre ]]]
 409 Sets its first argument in bold italic type.
 410 It operates similarly to the
 411 .B B
 412 macro otherwise.
 413 .TP
 414 .BI "\&.BX [" txt ]
 415 Prints its argument and draws a box around it.
 416 If you want to box a string that contains spaces,
 417 use a digit-width space (\[rs]0).
 418 .TP
 419 .BI "\&.UL [" txt " [" post ]]
 420 Prints its first argument with an underline.
 421 If you specify a second argument,
 422 .I groff
 423 prints it in the previous font after
 424 the underlined text, with no intervening space.
 425 .TP
 426 .B \&.LG
 427 Prints all text following in larger type
 428 (2\~points larger than the current point size) until
 429 the next font size, highlighting, paragraph, or heading macro.
 430 You can specify this macro multiple times
 431 to enlarge the point size as needed.
 432 .TP
 433 .B \&.SM
 434 Prints all text following in
 435 smaller type
 436 (2\~points smaller than the current point size) until
 437 the next type size, highlighting, paragraph, or heading macro.
 438 You can specify this macro multiple times
 439 to reduce the point size as needed.
 440 .TP
 441 .B \&.NL
 442 Prints all text following in
 443 the normal point size
 444 (that is, the value of the
 445 .B PS
 446 register).
 447 .TP
 448 .BI \[rs]*{ text \[rs]*}
 449 Print the enclosed
 450 .I text
 451 as a superscript.
 452 .\" -----
 453 .SS Indents
 454 You may need to indent sections of text.
 455 A typical use for indents is to create nested lists and sublists.
 456 .PP
 457 Use the
 458 .B RS
 459 and
 460 .B RE
 461 macros to start and end a section of indented text, respectively.
 462 The
 463 .B PI
 464 register controls the amount of indent.
 465 .PP
 466 You can nest indented sections as deeply as needed by
 467 using multiple, nested pairs of
 468 .B RS
 469 and
 470 .BR RE .
 471 .\" -----
 472 .SS Lists
 473 The
 474 .B IP
 475 macro handles duties for all lists.
 476 Its syntax is as follows:
 477 .TP
 478 .BI ".IP [" marker " [" width ]]
 479 .IP
 480 The
 481 .I marker
 482 is usually a bullet character
 483 .B \[rs](bu
 484 for unordered lists,
 485 a number (or auto-incrementing number register) for numbered lists,
 486 or a word or phrase for indented (glossary-style) lists.
 487 .IP
 488 The
 489 .I width
 490 specifies the indent for the body of each list item.
 491 Once specified, the indent remains the same for all
 492 list items in the document until specified again.
 493 .\" -----
 494 .br
 495 .ne 15
 496 .SS "Tab stops"
 497 Use the
 498 .B ta
 499 request to set tab stops as needed.
 500 Use the
 501 .B TA
 502 macro to reset tabs to the default (every 5n).
 503 You can redefine the
 504 .B TA
 505 macro to create a different set of default tab stops.
 506 .\" -----
 507 .SS "Displays and keeps"
 508 Use displays to show text-based examples or figures
 509 (such as code listings).
 510 Displays turn off filling, so lines of code can be
 511 displayed as-is without inserting
 512 .B br
 513 requests in between each line.
 514 Displays can be
 515 .I kept
 516 on a single page, or allowed to break across pages.
 517 The following table shows the display types available.
 518 .RS
 519 .ne 11
 520 .na
 521 .TS
 522 cb   s s    s cbt s s
 523 cb   s cb   s ^   s s
 524 lfCW s lfCW s l   s s.
 525 Display macro   Type of display
 526 With keep       No keep
 527 _
 528 \&.DS L \&.LD   Left-justified.
 529 \&.DS I [\fIindent\fP]  \&.ID   T{
 530 Indented (default indent in the \fBDI\fP register).
 531 T}
 532 \&.DS B \&.BD   T{
 533 Block-centered (left-justified, longest line centered).
 534 T}
 535 \&.DS C \&.CD   Centered.
 536 \&.DS R \&.RD   Right-justified.
 537 _
 538 .TE
 539 .RE
 540 .ad
 541 .LP
 542 Use the
 543 .B DE
 544 macro to end any display type.
 545 The macros
 546 .B Ds
 547 and
 548 .B De
 549 are aliases for
 550 .B DS
 551 and
 552 .BR DE ,
 553 respectively.
 554 .PP
 555 To
 556 .I keep
 557 text together on a page,
 558 such as
 559 a paragraph that refers to a table (or list, or other item)
 560 immediately following, use the
 561 .B KS
 562 and
 563 .B KE
 564 macros.
 565 The
 566 .B KS
 567 macro begins a block of text to be kept on a single page,
 568 and the
 569 .B KE
 570 macro ends the block.
 571 .PP
 572 You can specify a
 573 .I "floating keep"
 574 using the
 575 .B KF
 576 and
 577 .B KE
 578 macros.
 579 If the keep cannot fit on the current page,
 580 .I groff
 581 holds the contents of the keep and allows text following
 582 the keep (in the source file) to fill in the remainder of
 583 the current page.
 584 When the page breaks,
 585 whether by an explicit
 586 .B bp
 587 request or by reaching the end of the page,
 588 .I groff
 589 prints the floating keep at the top of the new page.
 590 This is useful for printing large graphics or tables
 591 that do not need to appear exactly where specified.
 592 .\" -----
 593 .SS "Tables, figures, equations, and references"
 594 The
 595 .I -ms
 596 macros support the standard
 597 .I groff
 598 preprocessors:
 599 .IR tbl ,
 600 .IR pic ,
 601 .IR eqn ,
 602 and
 603 .IR refer .
 604 Mark text meant for preprocessors by enclosing it
 605 in pairs of tags as follows:
 606 .TP
 607 .BR "\&.TS [H]" " and " \&.TE
 608 Denotes a table, to be processed by the
 609 .I tbl
 610 preprocessor.
 611 The optional
 612 .BR H "\~argument"
 613 instructs
 614 .I groff
 615 to create a running header with the information
 616 up to the
 617 .B TH
 618 macro.
 619 .I Groff
 620 prints the header at the beginning of the table;
 621 if the table runs onto another page,
 622 .I groff
 623 prints the header on the next page as well.
 624 .TP
 625 .BR \&.PS " and " \&.PE
 626 Denotes a graphic, to be processed by the
 627 .I pic
 628 preprocessor.
 629 You can create a
 630 .I pic
 631 file by hand, using the
 632 AT&T
 633 .I pic
 634 manual available on the Web as a reference,
 635 or by using a graphics program such as
 636 .IR xfig .
 637 .TP
 638 .BR "\&.EQ [\fI\,align\/\fP]" " and " \&.EN
 639 Denotes an equation, to be processed by the
 640 .I eqn
 641 preprocessor.
 642 The optional
 643 .I align
 644 argument can be
 645 .BR C ,
 646 .BR L ,
 647 or\~\c
 648 .B I
 649 to center (the default), left-justify, or indent
 650 the equation.
 651 .TP
 652 .BR \&.[ " and " \&.]
 653 Denotes a reference, to be processed by the
 654 .I refer
 655 preprocessor.
 656 The GNU
 657 .IR @g@refer (@MAN1EXT@)
 658 manual page provides a comprehensive reference
 659 to the preprocessor and the format of the
 660 bibliographic database.
 661 .\" -----
 662 .SS Footnotes
 663 The
 664 .I ms
 665 macros provide a flexible footnote system.
 666 You can specify a numbered footnote by using the
 667 .B \[rs]**
 668 escape, followed by the text of the footnote
 669 enclosed by
 670 .B FS
 671 and
 672 .B FE
 673 macros.
 674 .PP
 675 You can specify symbolic footnotes
 676 by placing the mark character (such as
 677 .B \[rs](dg
 678 for the dagger character) in the body text,
 679 followed by the text of the footnote
 680 enclosed by
 681 .B FS\ \[rs](dg
 682 and
 683 .B FE
 684 macros.
 685 .PP
 686 You can control how
 687 .I groff
 688 prints footnote numbers by changing the value of the
 689 .B FF
 690 register as follows:
 691 .RS
 692 .ne 7
 693 .TP
 694 0
 695 Prints the footnote number as a superscript; indents the footnote (default).
 696 .TP
 697 1
 698 Prints the number followed by a period (like\~1.\&)
 699 and indents the footnote.
 700 .TP
 701 2
 702 Like\~1, without an indent.
 703 .TP
 704 3
 705 Like\~1, but prints the footnote number as a hanging paragraph.
 706 .LP
 707 .RE
 708 You can use footnotes safely within keeps and displays,
 709 but avoid using numbered footnotes within floating keeps.
 710 You can set a second
 711 .B \[rs]**
 712 between a
 713 .B \[rs]**
 714 and its corresponding
 715 .BR .FS ;
 716 as long as each
 717 .B .FS
 718 occurs
 719 .I after
 720 the corresponding
 721 .B \[rs]**
 722 and the occurrences of
 723 .B .FS
 724 are in the same order as the corresponding occurrences of
 725 .BR \[rs]** .
 726 .\" -----
 727 .SS "Headers and footers"
 728 There are two ways to define headers and footers:
 729 .IP \(bu 3n
 730 Use the strings
 731 .BR LH ,
 732 .BR CH ,
 733 and
 734 .B RH
 735 to set the left, center, and right headers; use
 736 .BR LF ,
 737 .BR CF ,
 738 and
 739 .B RF
 740 to set the left, center, and right footers.
 741 This works best for documents that do not distinguish
 742 between odd and even pages.
 743 .IP \(bu
 744 Use the
 745 .B OH
 746 and
 747 .B EH
 748 macros to define headers for the odd and even pages; and
 749 .B OF
 750 and
 751 .B EF
 752 macros to define footers for the odd and even pages.
 753 This is more flexible than defining the individual strings.
 754 The syntax for these macros is as follows:
 755 .RS
 756 .IP
 757 .BI "\&.OH '" left ' center ' right '
 758 .RE
 759 .IP
 760 You can replace the quote (') marks with any character not
 761 appearing in the header or footer text.
 762 .\" -----
 763 .SS Margins
 764 You control margins using a set of number registers.
 765 The following table lists the register names and defaults:
 766 .RS
 767 .ne 8
 768 .na
 769 .TS
 770 cb   s cb s s cb s cb s
 771 afCW s l  s s l  s l  s.
 772 Reg.    Definition      Effective       Default
 773 _
 774 PO      T{
 775 Page offset (left margin)
 776 T}      next page       1i
 777 LL      T{
 778 Line length
 779 T}      next para.      6i
 780 LT      T{
 781 Header/footer length
 782 T}      next para.      6i
 783 HM      T{
 784 Top (header) margin
 785 T}      next page       1i
 786 FM      T{
 787 Bottom (footer) margin
 788 T}      next page       1i
 789 _
 790 .TE
 791 .RE
 792 .ad
 793 .PP
 794 Note that there is no right margin setting.
 795 The combination of page offset and line length
 796 provide the information necessary to
 797 derive the right margin.
 798 .\" -----
 799 .SS "Multiple columns"
 800 The
 801 .I ms
 802 macros can set text in as many columns as will reasonably
 803 fit on the page.
 804 The following macros are available.
 805 All of them force a page break if a multi-column mode is already set.
 806 However, if the current mode is single-column, starting a multi-column
 807 mode does
 808 .I not
 809 force a page break.
 810 .TP
 811 .B \&.1C
 812 Single-column mode.
 813 .TP
 814 .B \&.2C
 815 Two-column mode.
 816 .TP
 817 .BI "\&.MC [" width " [" gutter ]]
 818 Multi-column mode.
 819 If you specify no arguments, it is equivalent to the
 820 .B 2C
 821 macro.
 822 Otherwise,
 823 .I width
 824 is the width of each column and
 825 .I gutter
 826 is the space between columns.
 827 The
 828 .B MINGW
 829 number register is the default gutter width.
 830 .\" -----
 831 .SS "Creating a table of contents"
 832 Wrap text that you want to appear in the
 833 table of contents in
 834 .B XS
 835 and
 836 .B XE
 837 macros.
 838 Use the
 839 .B TC
 840 macro to print the table of contents at the end of the document,
 841 resetting the page number to\~\c
 842 .B i
 843 (Roman numeral\~1).
 844 .PP
 845 You can manually create a table of contents
 846 by specifying a page number as the first argument to
 847 .BR XS .
 848 Add subsequent entries using the
 849 .B XA
 850 macro.
 851 For example:
 852 .RS
 853 .PP
 854 .ne 8
 855 .nf
 856 \&.XS 1
 857 Introduction
 858 \&.XA 2
 859 A Brief History of the Universe
 860 \&.XA 729
 861 Details of Galactic Formation
 862 \&.\|.\|.
 863 \&.XE
 864 .fi
 865 .RE
 866 .LP
 867 Use the
 868 .B PX
 869 macro to print a manually-generated table of contents
 870 without resetting the page number.
 871 .PP
 872 If you give the argument
 873 .B no
 874 to either
 875 .B PX
 876 or
 877 .BR TC ,
 878 .I groff
 879 suppresses printing the title
 880 specified by the
 881 .B \[rs]*[TOC]
 882 string.
 883 .\" -----
 884 .SH "DIFFERENCES FROM troff ms"
 885 The
 886 .I "groff ms"
 887 macros are a complete re-implementation,
 888 using no original AT&T code.
 889 Since they take advantage of the extended features in
 890 .IR groff ,
 891 they cannot be used with AT&T
 892 .IR troff .
 893 Other differences include:
 894 .IP \(bu 3n
 895 The internals of
 896 .I "groff ms"
 897 differ from the internals of Unix
 898 .IR ms .
 899 Documents that depend upon implementation details of Unix
 900 .I ms
 901 may not format properly with
 902 .IR "groff ms" .
 903 .IP \(bu
 904 The error-handling policy of
 905 .I "groff ms"
 906 is to detect and report errors,
 907 rather than silently to ignore them.
 908 .IP \(bu
 909 Bell Labs localisms are not implemented.
 910 .IP \(bu
 911 Berkeley localisms, in particular the
 912 .B TM
 913 and
 914 .B CT
 915 macros,
 916 are not implemented.
 917 .IP \(bu
 918 .I "Groff ms"
 919 does not work in compatibility mode (e.g.\& with the
 920 .B \-C
 921 option).
 922 .IP \(bu
 923 There is no support for typewriter-like devices.
 924 .IP \(bu
 925 .I "Groff ms"
 926 does not provide cut marks.
 927 .IP \(bu
 928 Multiple line spacing is not supported
 929 (use a larger vertical spacing instead).
 930 .IP \(bu
 931 Some Unix
 932 .I ms
 933 documentation says that the
 934 .B CW
 935 and
 936 .B GW
 937 number registers can be used to control the column width and
 938 gutter width respectively.
 939 These number registers are not used in groff ms.
 940 .IP \(bu
 941 Macros that cause a reset
 942 (paragraphs, headings, etc.)
 943 may change the indent.
 944 Macros that change the indent do not increment or decrement
 945 the indent, but rather set it absolutely.
 946 This can cause problems for documents that define
 947 additional macros of their own.
 948 The solution is to use not the
 949 .B in
 950 request but instead the
 951 .B RS
 952 and
 953 .B RE
 954 macros.
 955 .IP \(bu
 956 The number register
 957 .B GS
 958 is set to\~1 by the
 959 .I "groff ms"
 960 macros,
 961 but is not used by the Unix
 962 .I ms
 963 macros.
 964 Documents that need to determine whether
 965 they are being formatted with Unix
 966 .I ms
 967 or
 968 .I "groff ms"
 969 should use this number register.
 970 .br
 971 .ne 22
 972 .SS Strings
 973 You can redefine the following strings to adapt the
 974 .I "groff ms"
 975 macros to languages other than English:
 976 .TS
 977 center;
 978 cb cb
 979 afCW l .
 980 String  Default Value
 981 _
 982 REFERENCES      References
 983 ABSTRACT        ABSTRACT
 984 TOC     Table of Contents
 985 MONTH1  January
 986 MONTH2  February
 987 MONTH3  March
 988 MONTH4  April
 989 MONTH5  May
 990 MONTH6  June
 991 MONTH7  July
 992 MONTH8  August
 993 MONTH9  September
 994 MONTH10 October
 995 MONTH11 November
 996 MONTH12 December
 997 _
 998 .TE
 999 .PP
1000 The
1001 .B \[rs]*-
1002 string produces an em dash \[em] like this.
1003 .\" -----
1004 .SS Text Settings
1005 The
1006 .B FAM
1007 string sets the default font family.
1008 If this string is undefined at initialization,
1009 it is set to Times.
1010 .LP
1011 The point size, vertical spacing, and inter-paragraph spacing for footnotes
1012 are controlled by the number registers
1013 .BR FPS ,
1014 .BR FVS ,
1015 and
1016 .BR FPD ;
1017 at initialization these are set to
1018 .BR \[rs]n(PS-2 ,
1019 .BR \[rs]n[FPS]+2 ,
1020 and
1021 .B \[rs]n(PD/2
1022 respectively.
1023 If any of these registers are defined before initialization,
1024 the initialization macro does not change them.
1025 .LP
1026 The hyphenation flags (as set by the
1027 .B hy
1028 request) are set from the
1029 .B HY
1030 register;
1031 the default is\~14.
1032 .PP
1033 Improved accent marks
1034 (as originally defined in Berkeley's
1035 .I ms
1036 version)
1037 are available by specifying the
1038 .B AM
1039 macro at the beginning of your document.
1040 You can place an accent over most characters
1041 by specifying the string defining the accent
1042 directly after the character.
1043 For example,
1044 .B n\[rs]*~
1045 produces an n with a tilde over it.
1046 .\" -----
1047 .SH "NAMING CONVENTIONS"
1048 .LP
1049 The following conventions are used for names of macros, strings and
1050 number registers.
1051 External names available to documents that use the
1052 .I "groff ms"
1053 macros contain only uppercase letters and digits.
1054 .LP
1055 Internally the macros are divided into modules;
1056 naming conventions are as follows:
1057 .IP \(bu 3n
1058 Names used only within one module are of the form
1059 .IB \%module * name\fR.
1060 .IP \(bu
1061 Names used outside the module in which they are defined are of the form
1062 .IB \%module @ name\fR.
1063 .IP \(bu
1064 Names associated with a particular environment are of the form
1065 .IB \%environment : name;
1066 these are used only within the
1067 .B par
1068 module.
1069 .IP \(bu
1070 .I name
1071 does not have a module prefix.
1072 .IP \(bu
1073 Constructed names used to implement arrays are of the form
1074 .IB \%array ! index\fR.
1075 .PP
1076 Thus the groff ms macros reserve the following names:
1077 .IP \(bu 3n
1078 Names containing the characters
1079 .BR * ,
1080 .BR @ ,
1081 and\~\c
1082 .BR : .
1083 .IP \(bu
1084 Names containing only uppercase letters and digits.
1085 .SH FILES
1086 .B @MACRODIR@/ms.tmac
1087 (a wrapper file for
1088 .BR s.tmac )
1089 .br
1090 .B @MACRODIR@/s.tmac
1091 .SH "SEE ALSO"
1092 .BR groff (@MAN1EXT@),
1093 .BR @g@troff (@MAN1EXT@),
1094 .BR @g@tbl (@MAN1EXT@),
1095 .BR @g@pic (@MAN1EXT@),
1096 .BR @g@eqn (@MAN1EXT@),
1097 .BR @g@refer (@MAN1EXT@),
1098 .I Groff: The GNU Implementation of troff
1099 by Trent Fisher and Werner Lemberg.
1100 .SH AUTHOR
1101 Original manual page by James Clark
1102 .IR "et al" ;
1103 rewritten by Larry Kollar
1104 (\fIlkollar@despammed.com\fR).
1105 .\" Local Variables:
1106 .\" mode: nroff
1107 .\" End: