contrib/groff/doc/groff-9

   1 This is groff, produced by makeinfo version 4.2 from ./groff.texinfo.
   2
   3 This manual documents GNU `troff' version 1.18.
   4
   5    Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc.
   6
   7      Permission is granted to copy, distribute and/or modify this
   8      document under the terms of the GNU Free Documentation License,
   9      Version 1.1 or any later version published by the Free Software
  10      Foundation; with no Invariant Sections, with the Front-Cover texts
  11      being `A GNU Manual," and with the Back-Cover Texts as in (a)
  12      below.  A copy of the license is included in the section entitled
  13      `GNU Free Documentation License."
  14
  15      (a) The FSF's Back-Cover Text is: `You have freedom to copy and
  16      modify this GNU Manual, like GNU software.  Copies published by
  17      the Free Software Foundation raise funds for GNU development."
  18
  19 INFO-DIR-SECTION Miscellaneous
  20 START-INFO-DIR-ENTRY
  21 * Groff: (groff).               The GNU troff document formatting system.
  22 END-INFO-DIR-ENTRY
  23
  24 \1f
  25 File: groff,  Node: GNU Free Documentation License,  Up: Copying This Manual
  26
  27 GNU Free Documentation License
  28 ==============================
  29
  30                         Version 1.1, March 2000
  31      Copyright (C) 2000 Free Software Foundation, Inc.
  32      59 Temple Place, Suite 330, Boston, MA  02111-1307, USA
  33
  34      Everyone is permitted to copy and distribute verbatim copies
  35      of this license document, but changing it is not allowed.
  36
  37   0. PREAMBLE
  38
  39      The purpose of this License is to make a manual, textbook, or other
  40      written document "free" in the sense of freedom: to assure everyone
  41      the effective freedom to copy and redistribute it, with or without
  42      modifying it, either commercially or noncommercially.  Secondarily,
  43      this License preserves for the author and publisher a way to get
  44      credit for their work, while not being considered responsible for
  45      modifications made by others.
  46
  47      This License is a kind of "copyleft", which means that derivative
  48      works of the document must themselves be free in the same sense.
  49      It complements the GNU General Public License, which is a copyleft
  50      license designed for free software.
  51
  52      We have designed this License in order to use it for manuals for
  53      free software, because free software needs free documentation: a
  54      free program should come with manuals providing the same freedoms
  55      that the software does.  But this License is not limited to
  56      software manuals; it can be used for any textual work, regardless
  57      of subject matter or whether it is published as a printed book.
  58      We recommend this License principally for works whose purpose is
  59      instruction or reference.
  60
  61   1. APPLICABILITY AND DEFINITIONS
  62
  63      This License applies to any manual or other work that contains a
  64      notice placed by the copyright holder saying it can be distributed
  65      under the terms of this License.  The "Document", below, refers to
  66      any such manual or work.  Any member of the public is a licensee,
  67      and is addressed as "you".
  68
  69      A "Modified Version" of the Document means any work containing the
  70      Document or a portion of it, either copied verbatim, or with
  71      modifications and/or translated into another language.
  72
  73      A "Secondary Section" is a named appendix or a front-matter
  74      section of the Document that deals exclusively with the
  75      relationship of the publishers or authors of the Document to the
  76      Document's overall subject (or to related matters) and contains
  77      nothing that could fall directly within that overall subject.
  78      (For example, if the Document is in part a textbook of
  79      mathematics, a Secondary Section may not explain any mathematics.)
  80      The relationship could be a matter of historical connection with
  81      the subject or with related matters, or of legal, commercial,
  82      philosophical, ethical or political position regarding them.
  83
  84      The "Invariant Sections" are certain Secondary Sections whose
  85      titles are designated, as being those of Invariant Sections, in
  86      the notice that says that the Document is released under this
  87      License.
  88
  89      The "Cover Texts" are certain short passages of text that are
  90      listed, as Front-Cover Texts or Back-Cover Texts, in the notice
  91      that says that the Document is released under this License.
  92
  93      A "Transparent" copy of the Document means a machine-readable copy,
  94      represented in a format whose specification is available to the
  95      general public, whose contents can be viewed and edited directly
  96      and straightforwardly with generic text editors or (for images
  97      composed of pixels) generic paint programs or (for drawings) some
  98      widely available drawing editor, and that is suitable for input to
  99      text formatters or for automatic translation to a variety of
 100      formats suitable for input to text formatters.  A copy made in an
 101      otherwise Transparent file format whose markup has been designed
 102      to thwart or discourage subsequent modification by readers is not
 103      Transparent.  A copy that is not "Transparent" is called "Opaque".
 104
 105      Examples of suitable formats for Transparent copies include plain
 106      ASCII without markup, Texinfo input format, LaTeX input format,
 107      SGML or XML using a publicly available DTD, and
 108      standard-conforming simple HTML designed for human modification.
 109      Opaque formats include PostScript, PDF, proprietary formats that
 110      can be read and edited only by proprietary word processors, SGML
 111      or XML for which the DTD and/or processing tools are not generally
 112      available, and the machine-generated HTML produced by some word
 113      processors for output purposes only.
 114
 115      The "Title Page" means, for a printed book, the title page itself,
 116      plus such following pages as are needed to hold, legibly, the
 117      material this License requires to appear in the title page.  For
 118      works in formats which do not have any title page as such, "Title
 119      Page" means the text near the most prominent appearance of the
 120      work's title, preceding the beginning of the body of the text.
 121
 122   2. VERBATIM COPYING
 123
 124      You may copy and distribute the Document in any medium, either
 125      commercially or noncommercially, provided that this License, the
 126      copyright notices, and the license notice saying this License
 127      applies to the Document are reproduced in all copies, and that you
 128      add no other conditions whatsoever to those of this License.  You
 129      may not use technical measures to obstruct or control the reading
 130      or further copying of the copies you make or distribute.  However,
 131      you may accept compensation in exchange for copies.  If you
 132      distribute a large enough number of copies you must also follow
 133      the conditions in section 3.
 134
 135      You may also lend copies, under the same conditions stated above,
 136      and you may publicly display copies.
 137
 138   3. COPYING IN QUANTITY
 139
 140      If you publish printed copies of the Document numbering more than
 141      100, and the Document's license notice requires Cover Texts, you
 142      must enclose the copies in covers that carry, clearly and legibly,
 143      all these Cover Texts: Front-Cover Texts on the front cover, and
 144      Back-Cover Texts on the back cover.  Both covers must also clearly
 145      and legibly identify you as the publisher of these copies.  The
 146      front cover must present the full title with all words of the
 147      title equally prominent and visible.  You may add other material
 148      on the covers in addition.  Copying with changes limited to the
 149      covers, as long as they preserve the title of the Document and
 150      satisfy these conditions, can be treated as verbatim copying in
 151      other respects.
 152
 153      If the required texts for either cover are too voluminous to fit
 154      legibly, you should put the first ones listed (as many as fit
 155      reasonably) on the actual cover, and continue the rest onto
 156      adjacent pages.
 157
 158      If you publish or distribute Opaque copies of the Document
 159      numbering more than 100, you must either include a
 160      machine-readable Transparent copy along with each Opaque copy, or
 161      state in or with each Opaque copy a publicly-accessible
 162      computer-network location containing a complete Transparent copy
 163      of the Document, free of added material, which the general
 164      network-using public has access to download anonymously at no
 165      charge using public-standard network protocols.  If you use the
 166      latter option, you must take reasonably prudent steps, when you
 167      begin distribution of Opaque copies in quantity, to ensure that
 168      this Transparent copy will remain thus accessible at the stated
 169      location until at least one year after the last time you
 170      distribute an Opaque copy (directly or through your agents or
 171      retailers) of that edition to the public.
 172
 173      It is requested, but not required, that you contact the authors of
 174      the Document well before redistributing any large number of
 175      copies, to give them a chance to provide you with an updated
 176      version of the Document.
 177
 178   4. MODIFICATIONS
 179
 180      You may copy and distribute a Modified Version of the Document
 181      under the conditions of sections 2 and 3 above, provided that you
 182      release the Modified Version under precisely this License, with
 183      the Modified Version filling the role of the Document, thus
 184      licensing distribution and modification of the Modified Version to
 185      whoever possesses a copy of it.  In addition, you must do these
 186      things in the Modified Version:
 187
 188        A. Use in the Title Page (and on the covers, if any) a title
 189           distinct from that of the Document, and from those of
 190           previous versions (which should, if there were any, be listed
 191           in the History section of the Document).  You may use the
 192           same title as a previous version if the original publisher of
 193           that version gives permission.
 194
 195        B. List on the Title Page, as authors, one or more persons or
 196           entities responsible for authorship of the modifications in
 197           the Modified Version, together with at least five of the
 198           principal authors of the Document (all of its principal
 199           authors, if it has less than five).
 200
 201        C. State on the Title page the name of the publisher of the
 202           Modified Version, as the publisher.
 203
 204        D. Preserve all the copyright notices of the Document.
 205
 206        E. Add an appropriate copyright notice for your modifications
 207           adjacent to the other copyright notices.
 208
 209        F. Include, immediately after the copyright notices, a license
 210           notice giving the public permission to use the Modified
 211           Version under the terms of this License, in the form shown in
 212           the Addendum below.
 213
 214        G. Preserve in that license notice the full lists of Invariant
 215           Sections and required Cover Texts given in the Document's
 216           license notice.
 217
 218        H. Include an unaltered copy of this License.
 219
 220        I. Preserve the section entitled "History", and its title, and
 221           add to it an item stating at least the title, year, new
 222           authors, and publisher of the Modified Version as given on
 223           the Title Page.  If there is no section entitled "History" in
 224           the Document, create one stating the title, year, authors,
 225           and publisher of the Document as given on its Title Page,
 226           then add an item describing the Modified Version as stated in
 227           the previous sentence.
 228
 229        J. Preserve the network location, if any, given in the Document
 230           for public access to a Transparent copy of the Document, and
 231           likewise the network locations given in the Document for
 232           previous versions it was based on.  These may be placed in
 233           the "History" section.  You may omit a network location for a
 234           work that was published at least four years before the
 235           Document itself, or if the original publisher of the version
 236           it refers to gives permission.
 237
 238        K. In any section entitled "Acknowledgments" or "Dedications",
 239           preserve the section's title, and preserve in the section all
 240           the substance and tone of each of the contributor
 241           acknowledgments and/or dedications given therein.
 242
 243        L. Preserve all the Invariant Sections of the Document,
 244           unaltered in their text and in their titles.  Section numbers
 245           or the equivalent are not considered part of the section
 246           titles.
 247
 248        M. Delete any section entitled "Endorsements".  Such a section
 249           may not be included in the Modified Version.
 250
 251        N. Do not retitle any existing section as "Endorsements" or to
 252           conflict in title with any Invariant Section.
 253
 254      If the Modified Version includes new front-matter sections or
 255      appendices that qualify as Secondary Sections and contain no
 256      material copied from the Document, you may at your option
 257      designate some or all of these sections as invariant.  To do this,
 258      add their titles to the list of Invariant Sections in the Modified
 259      Version's license notice.  These titles must be distinct from any
 260      other section titles.
 261
 262      You may add a section entitled "Endorsements", provided it contains
 263      nothing but endorsements of your Modified Version by various
 264      parties--for example, statements of peer review or that the text
 265      has been approved by an organization as the authoritative
 266      definition of a standard.
 267
 268      You may add a passage of up to five words as a Front-Cover Text,
 269      and a passage of up to 25 words as a Back-Cover Text, to the end
 270      of the list of Cover Texts in the Modified Version.  Only one
 271      passage of Front-Cover Text and one of Back-Cover Text may be
 272      added by (or through arrangements made by) any one entity.  If the
 273      Document already includes a cover text for the same cover,
 274      previously added by you or by arrangement made by the same entity
 275      you are acting on behalf of, you may not add another; but you may
 276      replace the old one, on explicit permission from the previous
 277      publisher that added the old one.
 278
 279      The author(s) and publisher(s) of the Document do not by this
 280      License give permission to use their names for publicity for or to
 281      assert or imply endorsement of any Modified Version.
 282
 283   5. COMBINING DOCUMENTS
 284
 285      You may combine the Document with other documents released under
 286      this License, under the terms defined in section 4 above for
 287      modified versions, provided that you include in the combination
 288      all of the Invariant Sections of all of the original documents,
 289      unmodified, and list them all as Invariant Sections of your
 290      combined work in its license notice.
 291
 292      The combined work need only contain one copy of this License, and
 293      multiple identical Invariant Sections may be replaced with a single
 294      copy.  If there are multiple Invariant Sections with the same name
 295      but different contents, make the title of each such section unique
 296      by adding at the end of it, in parentheses, the name of the
 297      original author or publisher of that section if known, or else a
 298      unique number.  Make the same adjustment to the section titles in
 299      the list of Invariant Sections in the license notice of the
 300      combined work.
 301
 302      In the combination, you must combine any sections entitled
 303      "History" in the various original documents, forming one section
 304      entitled "History"; likewise combine any sections entitled
 305      "Acknowledgments", and any sections entitled "Dedications".  You
 306      must delete all sections entitled "Endorsements."
 307
 308   6. COLLECTIONS OF DOCUMENTS
 309
 310      You may make a collection consisting of the Document and other
 311      documents released under this License, and replace the individual
 312      copies of this License in the various documents with a single copy
 313      that is included in the collection, provided that you follow the
 314      rules of this License for verbatim copying of each of the
 315      documents in all other respects.
 316
 317      You may extract a single document from such a collection, and
 318      distribute it individually under this License, provided you insert
 319      a copy of this License into the extracted document, and follow
 320      this License in all other respects regarding verbatim copying of
 321      that document.
 322
 323   7. AGGREGATION WITH INDEPENDENT WORKS
 324
 325      A compilation of the Document or its derivatives with other
 326      separate and independent documents or works, in or on a volume of
 327      a storage or distribution medium, does not as a whole count as a
 328      Modified Version of the Document, provided no compilation
 329      copyright is claimed for the compilation.  Such a compilation is
 330      called an "aggregate", and this License does not apply to the
 331      other self-contained works thus compiled with the Document, on
 332      account of their being thus compiled, if they are not themselves
 333      derivative works of the Document.
 334
 335      If the Cover Text requirement of section 3 is applicable to these
 336      copies of the Document, then if the Document is less than one
 337      quarter of the entire aggregate, the Document's Cover Texts may be
 338      placed on covers that surround only the Document within the
 339      aggregate.  Otherwise they must appear on covers around the whole
 340      aggregate.
 341
 342   8. TRANSLATION
 343
 344      Translation is considered a kind of modification, so you may
 345      distribute translations of the Document under the terms of section
 346      4.  Replacing Invariant Sections with translations requires special
 347      permission from their copyright holders, but you may include
 348      translations of some or all Invariant Sections in addition to the
 349      original versions of these Invariant Sections.  You may include a
 350      translation of this License provided that you also include the
 351      original English version of this License.  In case of a
 352      disagreement between the translation and the original English
 353      version of this License, the original English version will prevail.
 354
 355   9. TERMINATION
 356
 357      You may not copy, modify, sublicense, or distribute the Document
 358      except as expressly provided for under this License.  Any other
 359      attempt to copy, modify, sublicense or distribute the Document is
 360      void, and will automatically terminate your rights under this
 361      License.  However, parties who have received copies, or rights,
 362      from you under this License will not have their licenses
 363      terminated so long as such parties remain in full compliance.
 364
 365  10. FUTURE REVISIONS OF THIS LICENSE
 366
 367      The Free Software Foundation may publish new, revised versions of
 368      the GNU Free Documentation License from time to time.  Such new
 369      versions will be similar in spirit to the present version, but may
 370      differ in detail to address new problems or concerns.  See
 371      `http://www.gnu.org/copyleft/'.
 372
 373      Each version of the License is given a distinguishing version
 374      number.  If the Document specifies that a particular numbered
 375      version of this License "or any later version" applies to it, you
 376      have the option of following the terms and conditions either of
 377      that specified version or of any later version that has been
 378      published (not as a draft) by the Free Software Foundation.  If
 379      the Document does not specify a version number of this License,
 380      you may choose any version ever published (not as a draft) by the
 381      Free Software Foundation.
 382
 383 ADDENDUM: How to use this License for your documents
 384 ----------------------------------------------------
 385
 386    To use this License in a document you have written, include a copy of
 387 the License in the document and put the following copyright and license
 388 notices just after the title page:
 389
 390        Copyright (C)  YEAR  YOUR NAME.
 391        Permission is granted to copy, distribute and/or modify this document
 392        under the terms of the GNU Free Documentation License, Version 1.1
 393        or any later version published by the Free Software Foundation;
 394        with the Invariant Sections being LIST THEIR TITLES, with the
 395        Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
 396        A copy of the license is included in the section entitled ``GNU
 397        Free Documentation License''.
 398
 399    If you have no Invariant Sections, write "with no Invariant Sections"
 400 instead of saying which ones are invariant.  If you have no Front-Cover
 401 Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being
 402 LIST"; likewise for Back-Cover Texts.
 403
 404    If your document contains nontrivial examples of program code, we
 405 recommend releasing these examples in parallel under your choice of
 406 free software license, such as the GNU General Public License, to
 407 permit their use in free software.
 408
 409 \1f
 410 File: groff,  Node: Request Index,  Next: Escape Index,  Prev: Copying This Manual,  Up: Top
 411
 412 Request Index
 413 *************
 414
 415    Requests appear without the leading control character (normally
 416 either `.' or `'').
 417
 418 * Menu:
 419
 420 * ab:                                    Debugging.
 421 * ad:                                    Manipulating Filling and Adjusting.
 422 * af:                                    Assigning Formats.
 423 * aln:                                   Setting Registers.
 424 * als:                                   Strings.
 425 * am:                                    Writing Macros.
 426 * am1:                                   Writing Macros.
 427 * ami:                                   Writing Macros.
 428 * as:                                    Strings.
 429 * as1:                                   Strings.
 430 * asciify:                               Diversions.
 431 * backtrace:                             Debugging.
 432 * bd:                                    Artificial Fonts.
 433 * blm:                                   Blank Line Traps.
 434 * box:                                   Diversions.
 435 * boxa:                                  Diversions.
 436 * bp:                                    Page Control.
 437 * br:                                    Manipulating Filling and Adjusting.
 438 * break:                                 while.
 439 * brp:                                   Manipulating Filling and Adjusting.
 440 * c2:                                    Character Translations.
 441 * cc:                                    Character Translations.
 442 * ce:                                    Manipulating Filling and Adjusting.
 443 * cf:                                    I/O.
 444 * cflags:                                Using Symbols.
 445 * ch:                                    Page Location Traps.
 446 * char:                                  Using Symbols.
 447 * chop:                                  Strings.
 448 * close:                                 I/O.
 449 * color:                                 Colors.
 450 * continue:                              while.
 451 * cp:                                    Implementation Differences.
 452 * cs:                                    Artificial Fonts.
 453 * cu:                                    Artificial Fonts.
 454 * da:                                    Diversions.
 455 * de:                                    Writing Macros.
 456 * de1:                                   Writing Macros.
 457 * defcolor:                              Colors.
 458 * dei:                                   Writing Macros.
 459 * di:                                    Diversions.
 460 * do:                                    Implementation Differences.
 461 * ds:                                    Strings.
 462 * ds1:                                   Strings.
 463 * dt:                                    Diversion Traps.
 464 * ec:                                    Character Translations.
 465 * ecr:                                   Character Translations.
 466 * ecs:                                   Character Translations.
 467 * el:                                    if-else.
 468 * em:                                    End-of-input Traps.
 469 * eo:                                    Character Translations.
 470 * ev:                                    Environments.
 471 * evc:                                   Environments.
 472 * ex:                                    Debugging.
 473 * fam:                                   Font Families.
 474 * fc:                                    Fields.
 475 * fchar:                                 Using Symbols.
 476 * fi:                                    Manipulating Filling and Adjusting.
 477 * fl:                                    Debugging.
 478 * fp:                                    Font Positions.
 479 * fspecial:                              Special Fonts.
 480 * ft <1>:                                Font Positions.
 481 * ft:                                    Changing Fonts.
 482 * ftr:                                   Changing Fonts.
 483 * hc:                                    Manipulating Hyphenation.
 484 * hcode:                                 Manipulating Hyphenation.
 485 * hla:                                   Manipulating Hyphenation.
 486 * hlm:                                   Manipulating Hyphenation.
 487 * hpf:                                   Manipulating Hyphenation.
 488 * hpfa:                                  Manipulating Hyphenation.
 489 * hpfcode:                               Manipulating Hyphenation.
 490 * hw:                                    Manipulating Hyphenation.
 491 * hy:                                    Manipulating Hyphenation.
 492 * hym:                                   Manipulating Hyphenation.
 493 * hys:                                   Manipulating Hyphenation.
 494 * ie:                                    if-else.
 495 * if:                                    if-else.
 496 * ig:                                    Comments.
 497 * in:                                    Line Layout.
 498 * it:                                    Input Line Traps.
 499 * itc:                                   Input Line Traps.
 500 * kern:                                  Ligatures and Kerning.
 501 * lc:                                    Leaders.
 502 * length:                                Strings.
 503 * lf:                                    Debugging.
 504 * lg:                                    Ligatures and Kerning.
 505 * linetabs:                              Tabs and Fields.
 506 * ll:                                    Line Layout.
 507 * ls:                                    Manipulating Spacing.
 508 * lt:                                    Page Layout.
 509 * mc:                                    Miscellaneous.
 510 * mk:                                    Page Motions.
 511 * mso:                                   I/O.
 512 * na:                                    Manipulating Filling and Adjusting.
 513 * ne:                                    Page Control.
 514 * nf:                                    Manipulating Filling and Adjusting.
 515 * nh:                                    Manipulating Hyphenation.
 516 * nm:                                    Miscellaneous.
 517 * nn:                                    Miscellaneous.
 518 * nop:                                   if-else.
 519 * nr <1>:                                Auto-increment.
 520 * nr:                                    Setting Registers.
 521 * nroff:                                 Troff and Nroff Mode.
 522 * ns:                                    Manipulating Spacing.
 523 * nx:                                    I/O.
 524 * open:                                  I/O.
 525 * opena:                                 I/O.
 526 * os:                                    Page Control.
 527 * output:                                Diversions.
 528 * pc:                                    Page Layout.
 529 * pi:                                    I/O.
 530 * pl:                                    Page Layout.
 531 * pm:                                    Debugging.
 532 * pn:                                    Page Layout.
 533 * pnr:                                   Debugging.
 534 * po:                                    Line Layout.
 535 * ps:                                    Changing Type Sizes.
 536 * psbb:                                  Miscellaneous.
 537 * pso:                                   I/O.
 538 * ptr:                                   Debugging.
 539 * pvs:                                   Changing Type Sizes.
 540 * rchar:                                 Using Symbols.
 541 * rd:                                    I/O.
 542 * return:                                Writing Macros.
 543 * rj:                                    Manipulating Filling and Adjusting.
 544 * rm:                                    Strings.
 545 * rn:                                    Strings.
 546 * rnn:                                   Setting Registers.
 547 * rr:                                    Setting Registers.
 548 * rs:                                    Manipulating Spacing.
 549 * rt:                                    Page Motions.
 550 * shc:                                   Manipulating Hyphenation.
 551 * shift:                                 Parameters.
 552 * sizes:                                 Changing Type Sizes.
 553 * so:                                    I/O.
 554 * sp:                                    Manipulating Spacing.
 555 * special:                               Special Fonts.
 556 * spreadwarn:                            Debugging.
 557 * ss:                                    Manipulating Filling and Adjusting.
 558 * sty:                                   Font Families.
 559 * substring:                             Strings.
 560 * sv:                                    Page Control.
 561 * sy:                                    I/O.
 562 * ta:                                    Tabs and Fields.
 563 * tc:                                    Tabs and Fields.
 564 * ti:                                    Line Layout.
 565 * tkf:                                   Ligatures and Kerning.
 566 * tl:                                    Page Layout.
 567 * tm:                                    Debugging.
 568 * tm1:                                   Debugging.
 569 * tmc:                                   Debugging.
 570 * tr:                                    Character Translations.
 571 * trf:                                   I/O.
 572 * trin:                                  Character Translations.
 573 * trnt:                                  Character Translations.
 574 * troff:                                 Troff and Nroff Mode.
 575 * uf:                                    Artificial Fonts.
 576 * ul:                                    Artificial Fonts.
 577 * unformat:                              Diversions.
 578 * vpt:                                   Page Location Traps.
 579 * vs:                                    Changing Type Sizes.
 580 * warn:                                  Debugging.
 581 * warnscale:                             Debugging.
 582 * wh:                                    Page Location Traps.
 583 * while:                                 while.
 584 * write:                                 I/O.
 585 * writec:                                I/O.
 586 * writem:                                I/O.
 587
 588 \1f
 589 File: groff,  Node: Escape Index,  Next: Operator Index,  Prev: Request Index,  Up: Top
 590
 591 Escape Index
 592 ************
 593
 594    Any escape sequence `\X' with X not in the list below emits a
 595 warning, printing glyph X.
 596
 597 * Menu:
 598
 599 * <colon>:                               Manipulating Hyphenation.
 600 * \:                                     Using Symbols.
 601 * \!:                                    Diversions.
 602 * \":                                    Comments.
 603 * \#:                                    Comments.
 604 * \$:                                    Parameters.
 605 * \$*:                                   Parameters.
 606 * \$0:                                   Parameters.
 607 * \$@:                                   Parameters.
 608 * \%:                                    Manipulating Hyphenation.
 609 * \&:                                    Ligatures and Kerning.
 610 * \':                                    Using Symbols.
 611 * \):                                    Ligatures and Kerning.
 612 * \*:                                    Strings.
 613 * \,:                                    Ligatures and Kerning.
 614 * \-:                                    Using Symbols.
 615 * \.:                                    Character Translations.
 616 * \/:                                    Ligatures and Kerning.
 617 * \0:                                    Page Motions.
 618 * \<RET>:                                Line Control.
 619 * \<SP>:                                 Page Motions.
 620 * \?:                                    Diversions.
 621 * \\:                                    Character Translations.
 622 * \^:                                    Page Motions.
 623 * \`:                                    Using Symbols.
 624 * \a:                                    Leaders.
 625 * \A:                                    Identifiers.
 626 * \b:                                    Drawing Requests.
 627 * \B:                                    Expressions.
 628 * \C:                                    Using Symbols.
 629 * \c:                                    Line Control.
 630 * \D:                                    Drawing Requests.
 631 * \d:                                    Page Motions.
 632 * \E:                                    Character Translations.
 633 * \e:                                    Character Translations.
 634 * \f:                                    Font Positions.
 635 * \F:                                    Font Families.
 636 * \f:                                    Changing Fonts.
 637 * \g:                                    Assigning Formats.
 638 * \h:                                    Page Motions.
 639 * \H:                                    Artificial Fonts.
 640 * \k:                                    Page Motions.
 641 * \L:                                    Drawing Requests.
 642 * \l:                                    Drawing Requests.
 643 * \M:                                    Colors.
 644 * \m:                                    Colors.
 645 * \N:                                    Using Symbols.
 646 * \n <1>:                                Auto-increment.
 647 * \n:                                    Interpolating Registers.
 648 * \O:                                    Suppressing output.
 649 * \o:                                    Page Motions.
 650 * \p:                                    Manipulating Filling and Adjusting.
 651 * \r:                                    Page Motions.
 652 * \R:                                    Setting Registers.
 653 * \s:                                    Changing Type Sizes.
 654 * \S:                                    Artificial Fonts.
 655 * \t:                                    Tabs and Fields.
 656 * \u:                                    Page Motions.
 657 * \V:                                    I/O.
 658 * \v:                                    Page Motions.
 659 * \w:                                    Page Motions.
 660 * \X:                                    Postprocessor Access.
 661 * \x:                                    Manipulating Spacing.
 662 * \Y:                                    Postprocessor Access.
 663 * \Z:                                    Page Motions.
 664 * \z:                                    Page Motions.
 665 * \{:                                    if-else.
 666 * \|:                                    Page Motions.
 667 * \}:                                    if-else.
 668 * \~:                                    Page Motions.
 669
 670 \1f
 671 File: groff,  Node: Operator Index,  Next: Register Index,  Prev: Escape Index,  Up: Top
 672
 673 Operator Index
 674 **************
 675
 676 * Menu:
 677
 678 * !:                                     Expressions.
 679 * %:                                     Expressions.
 680 * &:                                     Expressions.
 681 * (:                                     Expressions.
 682 * ):                                     Expressions.
 683 * *:                                     Expressions.
 684 * +:                                     Expressions.
 685 * -:                                     Expressions.
 686 * /:                                     Expressions.
 687 * <:                                     Expressions.
 688 * <=:                                    Expressions.
 689 * <?:                                    Expressions.
 690 * <colon>:                               Expressions.
 691 * =:                                     Expressions.
 692 * ==:                                    Expressions.
 693 * >:                                     Expressions.
 694 * >=:                                    Expressions.
 695 * >?:                                    Expressions.
 696
 697 \1f
 698 File: groff,  Node: Register Index,  Next: Macro Index,  Prev: Operator Index,  Up: Top
 699
 700 Register Index
 701 **************
 702
 703    The macro package or program a specific register belongs to is
 704 appended in brackets.
 705
 706    A register name `x' consisting of exactly one character can be
 707 accessed as `\nx'.  A register name `xx' consisting of exactly two
 708 characters can be accessed as `\n(xx'.  Register names `xxx' of any
 709 length can be accessed as `\n[xxx]'.
 710
 711 * Menu:
 712
 713 * $$:                                    Built-in Registers.
 714 * %:                                     Page Layout.
 715 * .$:                                    Parameters.
 716 * .a:                                    Manipulating Spacing.
 717 * .A:                                    Built-in Registers.
 718 * .b:                                    Artificial Fonts.
 719 * .C:                                    Implementation Differences.
 720 * .c:                                    Built-in Registers.
 721 * .cdp:                                  Environments.
 722 * .ce:                                   Manipulating Filling and Adjusting.
 723 * .cht:                                  Environments.
 724 * .color:                                Colors.
 725 * .csk:                                  Environments.
 726 * .d:                                    Diversions.
 727 * .ev:                                   Environments.
 728 * .f:                                    Font Positions.
 729 * .F:                                    Built-in Registers.
 730 * .fam:                                  Font Families.
 731 * .fn:                                   Font Families.
 732 * .fp:                                   Font Positions.
 733 * .g:                                    Built-in Registers.
 734 * .h:                                    Diversions.
 735 * .H:                                    Built-in Registers.
 736 * .hla:                                  Manipulating Hyphenation.
 737 * .hlc:                                  Manipulating Hyphenation.
 738 * .hlm:                                  Manipulating Hyphenation.
 739 * .hy:                                   Manipulating Hyphenation.
 740 * .hym:                                  Manipulating Hyphenation.
 741 * .hys:                                  Manipulating Hyphenation.
 742 * .i:                                    Line Layout.
 743 * .in:                                   Line Layout.
 744 * .int:                                  Line Control.
 745 * .j:                                    Manipulating Filling and Adjusting.
 746 * .k:                                    Page Motions.
 747 * .kern:                                 Ligatures and Kerning.
 748 * .l:                                    Line Layout.
 749 * .L:                                    Manipulating Spacing.
 750 * .lg:                                   Ligatures and Kerning.
 751 * .linetabs:                             Tabs and Fields.
 752 * .ll:                                   Line Layout.
 753 * .lt:                                   Page Layout.
 754 * .ne:                                   Page Location Traps.
 755 * .ns:                                   Manipulating Spacing.
 756 * .o:                                    Line Layout.
 757 * .p:                                    Page Layout.
 758 * .P:                                    Built-in Registers.
 759 * .pn:                                   Page Layout.
 760 * .ps:                                   Fractional Type Sizes.
 761 * .psr:                                  Fractional Type Sizes.
 762 * .pvs:                                  Changing Type Sizes.
 763 * .rj:                                   Manipulating Filling and Adjusting.
 764 * .s:                                    Changing Type Sizes.
 765 * .sr:                                   Fractional Type Sizes.
 766 * .ss:                                   Manipulating Filling and Adjusting.
 767 * .sss:                                  Manipulating Filling and Adjusting.
 768 * .t:                                    Page Location Traps.
 769 * .T:                                    Built-in Registers.
 770 * .tabs:                                 Tabs and Fields.
 771 * .trunc:                                Page Location Traps.
 772 * .u:                                    Manipulating Filling and Adjusting.
 773 * .v:                                    Changing Type Sizes.
 774 * .V:                                    Built-in Registers.
 775 * .vpt:                                  Page Location Traps.
 776 * .warn:                                 Debugging.
 777 * .x:                                    Built-in Registers.
 778 * .Y:                                    Built-in Registers.
 779 * .y:                                    Built-in Registers.
 780 * .z:                                    Diversions.
 781 * c.:                                    Built-in Registers.
 782 * ct:                                    Page Motions.
 783 * dl:                                    Diversions.
 784 * dn:                                    Diversions.
 785 * dw:                                    Built-in Registers.
 786 * dy:                                    Built-in Registers.
 787 * FF [ms]:                               ms Document Control Registers.
 788 * FI [ms]:                               ms Document Control Registers.
 789 * FL [ms]:                               ms Document Control Registers.
 790 * FM [ms]:                               ms Document Control Registers.
 791 * HM [ms]:                               ms Document Control Registers.
 792 * hours:                                 Built-in Registers.
 793 * hp:                                    Page Motions.
 794 * LL [ms]:                               ms Document Control Registers.
 795 * llx:                                   Miscellaneous.
 796 * lly:                                   Miscellaneous.
 797 * ln:                                    Built-in Registers.
 798 * LT [ms]:                               ms Document Control Registers.
 799 * MINGW [ms] <1>:                        Additional ms Macros.
 800 * MINGW [ms]:                            ms Document Control Registers.
 801 * minutes:                               Built-in Registers.
 802 * mo:                                    Built-in Registers.
 803 * nl:                                    Page Control.
 804 * opmaxx:                                Suppressing output.
 805 * opmaxy:                                Suppressing output.
 806 * opminx:                                Suppressing output.
 807 * opminy:                                Suppressing output.
 808 * PD [ms]:                               ms Document Control Registers.
 809 * PI [ms]:                               ms Document Control Registers.
 810 * PO [ms]:                               ms Document Control Registers.
 811 * PS [ms]:                               ms Document Control Registers.
 812 * ps4html [grohtml]:                     grohtml specific registers and strings.
 813 * QI [ms]:                               ms Document Control Registers.
 814 * rsb:                                   Page Motions.
 815 * rst:                                   Page Motions.
 816 * sb:                                    Page Motions.
 817 * seconds:                               Built-in Registers.
 818 * skw:                                   Page Motions.
 819 * slimit:                                Debugging.
 820 * ssc:                                   Page Motions.
 821 * st:                                    Page Motions.
 822 * systat:                                I/O.
 823 * urx:                                   Miscellaneous.
 824 * ury:                                   Miscellaneous.
 825 * VS [ms]:                               ms Document Control Registers.
 826 * year:                                  Built-in Registers.
 827 * yr:                                    Built-in Registers.
 828
 829 \1f
 830 File: groff,  Node: Macro Index,  Next: String Index,  Prev: Register Index,  Up: Top
 831
 832 Macro Index
 833 ***********
 834
 835    The macro package a specific macro belongs to is appended in
 836 brackets.  They appear without the leading control character (normally
 837 `.').
 838
 839 * Menu:
 840
 841 * 1C [ms]:                               ms Multiple Columns.
 842 * 2C [ms]:                               ms Multiple Columns.
 843 * [ [ms]:                                ms Insertions.
 844 * ] [ms]:                                ms Insertions.
 845 * AB [ms]:                               ms Cover Page Macros.
 846 * AE [ms]:                               ms Cover Page Macros.
 847 * AI [ms]:                               ms Cover Page Macros.
 848 * AM [ms] <1>:                           Additional ms Macros.
 849 * AM [ms]:                               ms Strings and Special Characters.
 850 * AU [ms]:                               ms Cover Page Macros.
 851 * B [man]:                               Man font macros.
 852 * B [ms]:                                Highlighting in ms.
 853 * B1 [ms]:                               ms Displays and Keeps.
 854 * B2 [ms]:                               ms Displays and Keeps.
 855 * BD [ms]:                               ms Displays and Keeps.
 856 * BI [man]:                              Man font macros.
 857 * BI [ms]:                               Highlighting in ms.
 858 * BR [man]:                              Man font macros.
 859 * BX [ms]:                               Highlighting in ms.
 860 * CD [ms]:                               ms Displays and Keeps.
 861 * CW [ms] <1>:                           Additional ms Macros.
 862 * CW [ms]:                               Highlighting in ms.
 863 * DA [ms]:                               ms Cover Page Macros.
 864 * DE [ms]:                               ms Displays and Keeps.
 865 * DS [ms] <1>:                           Additional ms Macros.
 866 * DS [ms]:                               ms Displays and Keeps.
 867 * DT [man]:                              Miscellaneous man macros.
 868 * EF [ms]:                               ms Headers and Footers.
 869 * EH [ms]:                               ms Headers and Footers.
 870 * EN [ms]:                               ms Insertions.
 871 * EQ [ms]:                               ms Insertions.
 872 * FE [ms]:                               ms Footnotes.
 873 * FS [ms]:                               ms Footnotes.
 874 * HP [man]:                              Man usage.
 875 * I [man]:                               Man font macros.
 876 * I [ms]:                                Highlighting in ms.
 877 * IB [man]:                              Man font macros.
 878 * ID [ms]:                               ms Displays and Keeps.
 879 * IP [man]:                              Man usage.
 880 * IP [ms]:                               Lists in ms.
 881 * IR [man]:                              Man font macros.
 882 * IX [ms]:                               Additional ms Macros.
 883 * KE [ms]:                               ms Displays and Keeps.
 884 * KF [ms]:                               ms Displays and Keeps.
 885 * KS [ms]:                               ms Displays and Keeps.
 886 * LD [ms]:                               ms Displays and Keeps.
 887 * LG [ms]:                               Highlighting in ms.
 888 * LP [man]:                              Man usage.
 889 * LP [ms]:                               Paragraphs in ms.
 890 * MC [ms]:                               ms Multiple Columns.
 891 * ND [ms]:                               ms Cover Page Macros.
 892 * NH [ms]:                               Headings in ms.
 893 * NL [ms]:                               Highlighting in ms.
 894 * OF [ms]:                               ms Headers and Footers.
 895 * OH [ms]:                               ms Headers and Footers.
 896 * P [man]:                               Man usage.
 897 * PD [man]:                              Miscellaneous man macros.
 898 * PE [ms]:                               ms Insertions.
 899 * PP [man]:                              Man usage.
 900 * PP [ms]:                               Paragraphs in ms.
 901 * PS [ms]:                               ms Insertions.
 902 * PX [ms]:                               ms TOC.
 903 * QP [ms]:                               Paragraphs in ms.
 904 * R [ms]:                                Highlighting in ms.
 905 * RB [man]:                              Man font macros.
 906 * RD [ms]:                               ms Displays and Keeps.
 907 * RE [man]:                              Man usage.
 908 * RE [ms]:                               Indents in ms.
 909 * RI [man]:                              Man font macros.
 910 * RP [ms]:                               ms Cover Page Macros.
 911 * RS [man]:                              Man usage.
 912 * RS [ms]:                               Indents in ms.
 913 * SB [man]:                              Man font macros.
 914 * SH [man]:                              Man usage.
 915 * SH [ms]:                               Headings in ms.
 916 * SM [man]:                              Man font macros.
 917 * SM [ms]:                               Highlighting in ms.
 918 * SS [man]:                              Man usage.
 919 * TA [ms]:                               Tabstops in ms.
 920 * TC [ms]:                               ms TOC.
 921 * TE [ms]:                               ms Insertions.
 922 * TH [man]:                              Man usage.
 923 * TL [ms]:                               ms Cover Page Macros.
 924 * TP [man]:                              Man usage.
 925 * TS [ms]:                               ms Insertions.
 926 * UL [ms]:                               Highlighting in ms.
 927 * XA [ms]:                               ms TOC.
 928 * XE [ms]:                               ms TOC.
 929 * XP [ms]:                               Paragraphs in ms.
 930 * XS [ms]:                               ms TOC.
 931