summaryrefslogtreecommitdiffstats
path: root/contrib/groff/doc/groff-9
blob: 4f4cc68007a4cbdbf1a5585db7bcfa18cce5577d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
This is groff, produced by makeinfo version 4.2 from ./groff.texinfo.

This manual documents GNU `troff' version 1.18.

   Copyright (C) 1994-2000, 2001, 2002 Free Software Foundation, Inc.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.1 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover texts
     being `A GNU Manual," and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     `GNU Free Documentation License."

     (a) The FSF's Back-Cover Text is: `You have freedom to copy and
     modify this GNU Manual, like GNU software.  Copies published by
     the Free Software Foundation raise funds for GNU development."
   
INFO-DIR-SECTION Miscellaneous
START-INFO-DIR-ENTRY
* Groff: (groff).               The GNU troff document formatting system.
END-INFO-DIR-ENTRY


File: groff,  Node: GNU Free Documentation License,  Up: Copying This Manual

GNU Free Documentation License
==============================

                        Version 1.1, March 2000
     Copyright (C) 2000 Free Software Foundation, Inc.
     59 Temple Place, Suite 330, Boston, MA  02111-1307, USA
     
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.

  0. PREAMBLE

     The purpose of this License is to make a manual, textbook, or other
     written document "free" in the sense of freedom: to assure everyone
     the effective freedom to copy and redistribute it, with or without
     modifying it, either commercially or noncommercially.  Secondarily,
     this License preserves for the author and publisher a way to get
     credit for their work, while not being considered responsible for
     modifications made by others.

     This License is a kind of "copyleft", which means that derivative
     works of the document must themselves be free in the same sense.
     It complements the GNU General Public License, which is a copyleft
     license designed for free software.

     We have designed this License in order to use it for manuals for
     free software, because free software needs free documentation: a
     free program should come with manuals providing the same freedoms
     that the software does.  But this License is not limited to
     software manuals; it can be used for any textual work, regardless
     of subject matter or whether it is published as a printed book.
     We recommend this License principally for works whose purpose is
     instruction or reference.

  1. APPLICABILITY AND DEFINITIONS

     This License applies to any manual or other work that contains a
     notice placed by the copyright holder saying it can be distributed
     under the terms of this License.  The "Document", below, refers to
     any such manual or work.  Any member of the public is a licensee,
     and is addressed as "you".

     A "Modified Version" of the Document means any work containing the
     Document or a portion of it, either copied verbatim, or with
     modifications and/or translated into another language.

     A "Secondary Section" is a named appendix or a front-matter
     section of the Document that deals exclusively with the
     relationship of the publishers or authors of the Document to the
     Document's overall subject (or to related matters) and contains
     nothing that could fall directly within that overall subject.
     (For example, if the Document is in part a textbook of
     mathematics, a Secondary Section may not explain any mathematics.)
     The relationship could be a matter of historical connection with
     the subject or with related matters, or of legal, commercial,
     philosophical, ethical or political position regarding them.

     The "Invariant Sections" are certain Secondary Sections whose
     titles are designated, as being those of Invariant Sections, in
     the notice that says that the Document is released under this
     License.

     The "Cover Texts" are certain short passages of text that are
     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
     that says that the Document is released under this License.

     A "Transparent" copy of the Document means a machine-readable copy,
     represented in a format whose specification is available to the
     general public, whose contents can be viewed and edited directly
     and straightforwardly with generic text editors or (for images
     composed of pixels) generic paint programs or (for drawings) some
     widely available drawing editor, and that is suitable for input to
     text formatters or for automatic translation to a variety of
     formats suitable for input to text formatters.  A copy made in an
     otherwise Transparent file format whose markup has been designed
     to thwart or discourage subsequent modification by readers is not
     Transparent.  A copy that is not "Transparent" is called "Opaque".

     Examples of suitable formats for Transparent copies include plain
     ASCII without markup, Texinfo input format, LaTeX input format,
     SGML or XML using a publicly available DTD, and
     standard-conforming simple HTML designed for human modification.
     Opaque formats include PostScript, PDF, proprietary formats that
     can be read and edited only by proprietary word processors, SGML
     or XML for which the DTD and/or processing tools are not generally
     available, and the machine-generated HTML produced by some word
     processors for output purposes only.

     The "Title Page" means, for a printed book, the title page itself,
     plus such following pages as are needed to hold, legibly, the
     material this License requires to appear in the title page.  For
     works in formats which do not have any title page as such, "Title
     Page" means the text near the most prominent appearance of the
     work's title, preceding the beginning of the body of the text.

  2. VERBATIM COPYING

     You may copy and distribute the Document in any medium, either
     commercially or noncommercially, provided that this License, the
     copyright notices, and the license notice saying this License
     applies to the Document are reproduced in all copies, and that you
     add no other conditions whatsoever to those of this License.  You
     may not use technical measures to obstruct or control the reading
     or further copying of the copies you make or distribute.  However,
     you may accept compensation in exchange for copies.  If you
     distribute a large enough number of copies you must also follow
     the conditions in section 3.

     You may also lend copies, under the same conditions stated above,
     and you may publicly display copies.

  3. COPYING IN QUANTITY

     If you publish printed copies of the Document numbering more than
     100, and the Document's license notice requires Cover Texts, you
     must enclose the copies in covers that carry, clearly and legibly,
     all these Cover Texts: Front-Cover Texts on the front cover, and
     Back-Cover Texts on the back cover.  Both covers must also clearly
     and legibly identify you as the publisher of these copies.  The
     front cover must present the full title with all words of the
     title equally prominent and visible.  You may add other material
     on the covers in addition.  Copying with changes limited to the
     covers, as long as they preserve the title of the Document and
     satisfy these conditions, can be treated as verbatim copying in
     other respects.

     If the required texts for either cover are too voluminous to fit
     legibly, you should put the first ones listed (as many as fit
     reasonably) on the actual cover, and continue the rest onto
     adjacent pages.

     If you publish or distribute Opaque copies of the Document
     numbering more than 100, you must either include a
     machine-readable Transparent copy along with each Opaque copy, or
     state in or with each Opaque copy a publicly-accessible
     computer-network location containing a complete Transparent copy
     of the Document, free of added material, which the general
     network-using public has access to download anonymously at no
     charge using public-standard network protocols.  If you use the
     latter option, you must take reasonably prudent steps, when you
     begin distribution of Opaque copies in quantity, to ensure that
     this Transparent copy will remain thus accessible at the stated
     location until at least one year after the last time you
     distribute an Opaque copy (directly or through your agents or
     retailers) of that edition to the public.

     It is requested, but not required, that you contact the authors of
     the Document well before redistributing any large number of
     copies, to give them a chance to provide you with an updated
     version of the Document.

  4. MODIFICATIONS

     You may copy and distribute a Modified Version of the Document
     under the conditions of sections 2 and 3 above, provided that you
     release the Modified Version under precisely this License, with
     the Modified Version filling the role of the Document, thus
     licensing distribution and modification of the Modified Version to
     whoever possesses a copy of it.  In addition, you must do these
     things in the Modified Version:

       A. Use in the Title Page (and on the covers, if any) a title
          distinct from that of the Document, and from those of
          previous versions (which should, if there were any, be listed
          in the History section of the Document).  You may use the
          same title as a previous version if the original publisher of
          that version gives permission.

       B. List on the Title Page, as authors, one or more persons or
          entities responsible for authorship of the modifications in
          the Modified Version, together with at least five of the
          principal authors of the Document (all of its principal
          authors, if it has less than five).

       C. State on the Title page the name of the publisher of the
          Modified Version, as the publisher.

       D. Preserve all the copyright notices of the Document.

       E. Add an appropriate copyright notice for your modifications
          adjacent to the other copyright notices.

       F. Include, immediately after the copyright notices, a license
          notice giving the public permission to use the Modified
          Version under the terms of this License, in the form shown in
          the Addendum below.

       G. Preserve in that license notice the full lists of Invariant
          Sections and required Cover Texts given in the Document's
          license notice.

       H. Include an unaltered copy of this License.

       I. Preserve the section entitled "History", and its title, and
          add to it an item stating at least the title, year, new
          authors, and publisher of the Modified Version as given on
          the Title Page.  If there is no section entitled "History" in
          the Document, create one stating the title, year, authors,
          and publisher of the Document as given on its Title Page,
          then add an item describing the Modified Version as stated in
          the previous sentence.

       J. Preserve the network location, if any, given in the Document
          for public access to a Transparent copy of the Document, and
          likewise the network locations given in the Document for
          previous versions it was based on.  These may be placed in
          the "History" section.  You may omit a network location for a
          work that was published at least four years before the
          Document itself, or if the original publisher of the version
          it refers to gives permission.

       K. In any section entitled "Acknowledgments" or "Dedications",
          preserve the section's title, and preserve in the section all
          the substance and tone of each of the contributor
          acknowledgments and/or dedications given therein.

       L. Preserve all the Invariant Sections of the Document,
          unaltered in their text and in their titles.  Section numbers
          or the equivalent are not considered part of the section
          titles.

       M. Delete any section entitled "Endorsements".  Such a section
          may not be included in the Modified Version.

       N. Do not retitle any existing section as "Endorsements" or to
          conflict in title with any Invariant Section.

     If the Modified Version includes new front-matter sections or
     appendices that qualify as Secondary Sections and contain no
     material copied from the Document, you may at your option
     designate some or all of these sections as invariant.  To do this,
     add their titles to the list of Invariant Sections in the Modified
     Version's license notice.  These titles must be distinct from any
     other section titles.

     You may add a section entitled "Endorsements", provided it contains
     nothing but endorsements of your Modified Version by various
     parties--for example, statements of peer review or that the text
     has been approved by an organization as the authoritative
     definition of a standard.

     You may add a passage of up to five words as a Front-Cover Text,
     and a passage of up to 25 words as a Back-Cover Text, to the end
     of the list of Cover Texts in the Modified Version.  Only one
     passage of Front-Cover Text and one of Back-Cover Text may be
     added by (or through arrangements made by) any one entity.  If the
     Document already includes a cover text for the same cover,
     previously added by you or by arrangement made by the same entity
     you are acting on behalf of, you may not add another; but you may
     replace the old one, on explicit permission from the previous
     publisher that added the old one.

     The author(s) and publisher(s) of the Document do not by this
     License give permission to use their names for publicity for or to
     assert or imply endorsement of any Modified Version.

  5. COMBINING DOCUMENTS

     You may combine the Document with other documents released under
     this License, under the terms defined in section 4 above for
     modified versions, provided that you include in the combination
     all of the Invariant Sections of all of the original documents,
     unmodified, and list them all as Invariant Sections of your
     combined work in its license notice.

     The combined work need only contain one copy of this License, and
     multiple identical Invariant Sections may be replaced with a single
     copy.  If there are multiple Invariant Sections with the same name
     but different contents, make the title of each such section unique
     by adding at the end of it, in parentheses, the name of the
     original author or publisher of that section if known, or else a
     unique number.  Make the same adjustment to the section titles in
     the list of Invariant Sections in the license notice of the
     combined work.

     In the combination, you must combine any sections entitled
     "History" in the various original documents, forming one section
     entitled "History"; likewise combine any sections entitled
     "Acknowledgments", and any sections entitled "Dedications".  You
     must delete all sections entitled "Endorsements."

  6. COLLECTIONS OF DOCUMENTS

     You may make a collection consisting of the Document and other
     documents released under this License, and replace the individual
     copies of this License in the various documents with a single copy
     that is included in the collection, provided that you follow the
     rules of this License for verbatim copying of each of the
     documents in all other respects.

     You may extract a single document from such a collection, and
     distribute it individually under this License, provided you insert
     a copy of this License into the extracted document, and follow
     this License in all other respects regarding verbatim copying of
     that document.

  7. AGGREGATION WITH INDEPENDENT WORKS

     A compilation of the Document or its derivatives with other
     separate and independent documents or works, in or on a volume of
     a storage or distribution medium, does not as a whole count as a
     Modified Version of the Document, provided no compilation
     copyright is claimed for the compilation.  Such a compilation is
     called an "aggregate", and this License does not apply to the
     other self-contained works thus compiled with the Document, on
     account of their being thus compiled, if they are not themselves
     derivative works of the Document.

     If the Cover Text requirement of section 3 is applicable to these
     copies of the Document, then if the Document is less than one
     quarter of the entire aggregate, the Document's Cover Texts may be
     placed on covers that surround only the Document within the
     aggregate.  Otherwise they must appear on covers around the whole
     aggregate.

  8. TRANSLATION

     Translation is considered a kind of modification, so you may
     distribute translations of the Document under the terms of section
     4.  Replacing Invariant Sections with translations requires special
     permission from their copyright holders, but you may include
     translations of some or all Invariant Sections in addition to the
     original versions of these Invariant Sections.  You may include a
     translation of this License provided that you also include the
     original English version of this License.  In case of a
     disagreement between the translation and the original English
     version of this License, the original English version will prevail.

  9. TERMINATION

     You may not copy, modify, sublicense, or distribute the Document
     except as expressly provided for under this License.  Any other
     attempt to copy, modify, sublicense or distribute the Document is
     void, and will automatically terminate your rights under this
     License.  However, parties who have received copies, or rights,
     from you under this License will not have their licenses
     terminated so long as such parties remain in full compliance.

 10. FUTURE REVISIONS OF THIS LICENSE

     The Free Software Foundation may publish new, revised versions of
     the GNU Free Documentation License from time to time.  Such new
     versions will be similar in spirit to the present version, but may
     differ in detail to address new problems or concerns.  See
     `http://www.gnu.org/copyleft/'.

     Each version of the License is given a distinguishing version
     number.  If the Document specifies that a particular numbered
     version of this License "or any later version" applies to it, you
     have the option of following the terms and conditions either of
     that specified version or of any later version that has been
     published (not as a draft) by the Free Software Foundation.  If
     the Document does not specify a version number of this License,
     you may choose any version ever published (not as a draft) by the
     Free Software Foundation.

ADDENDUM: How to use this License for your documents
----------------------------------------------------

   To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and license
notices just after the title page:

       Copyright (C)  YEAR  YOUR NAME.
       Permission is granted to copy, distribute and/or modify this document
       under the terms of the GNU Free Documentation License, Version 1.1
       or any later version published by the Free Software Foundation;
       with the Invariant Sections being LIST THEIR TITLES, with the
       Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
       A copy of the license is included in the section entitled ``GNU
       Free Documentation License''.

   If you have no Invariant Sections, write "with no Invariant Sections"
instead of saying which ones are invariant.  If you have no Front-Cover
Texts, write "no Front-Cover Texts" instead of "Front-Cover Texts being
LIST"; likewise for Back-Cover Texts.

   If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License, to
permit their use in free software.


File: groff,  Node: Request Index,  Next: Escape Index,  Prev: Copying This Manual,  Up: Top

Request Index
*************

   Requests appear without the leading control character (normally
either `.' or `'').

* Menu:

* ab:                                    Debugging.
* ad:                                    Manipulating Filling and Adjusting.
* af:                                    Assigning Formats.
* aln:                                   Setting Registers.
* als:                                   Strings.
* am:                                    Writing Macros.
* am1:                                   Writing Macros.
* ami:                                   Writing Macros.
* as:                                    Strings.
* as1:                                   Strings.
* asciify:                               Diversions.
* backtrace:                             Debugging.
* bd:                                    Artificial Fonts.
* blm:                                   Blank Line Traps.
* box:                                   Diversions.
* boxa:                                  Diversions.
* bp:                                    Page Control.
* br:                                    Manipulating Filling and Adjusting.
* break:                                 while.
* brp:                                   Manipulating Filling and Adjusting.
* c2:                                    Character Translations.
* cc:                                    Character Translations.
* ce:                                    Manipulating Filling and Adjusting.
* cf:                                    I/O.
* cflags:                                Using Symbols.
* ch:                                    Page Location Traps.
* char:                                  Using Symbols.
* chop:                                  Strings.
* close:                                 I/O.
* color:                                 Colors.
* continue:                              while.
* cp:                                    Implementation Differences.
* cs:                                    Artificial Fonts.
* cu:                                    Artificial Fonts.
* da:                                    Diversions.
* de:                                    Writing Macros.
* de1:                                   Writing Macros.
* defcolor:                              Colors.
* dei:                                   Writing Macros.
* di:                                    Diversions.
* do:                                    Implementation Differences.
* ds:                                    Strings.
* ds1:                                   Strings.
* dt:                                    Diversion Traps.
* ec:                                    Character Translations.
* ecr:                                   Character Translations.
* ecs:                                   Character Translations.
* el:                                    if-else.
* em:                                    End-of-input Traps.
* eo:                                    Character Translations.
* ev:                                    Environments.
* evc:                                   Environments.
* ex:                                    Debugging.
* fam:                                   Font Families.
* fc:                                    Fields.
* fchar:                                 Using Symbols.
* fi:                                    Manipulating Filling and Adjusting.
* fl:                                    Debugging.
* fp:                                    Font Positions.
* fspecial:                              Special Fonts.
* ft <1>:                                Font Positions.
* ft:                                    Changing Fonts.
* ftr:                                   Changing Fonts.
* hc:                                    Manipulating Hyphenation.
* hcode:                                 Manipulating Hyphenation.
* hla:                                   Manipulating Hyphenation.
* hlm:                                   Manipulating Hyphenation.
* hpf:                                   Manipulating Hyphenation.
* hpfa:                                  Manipulating Hyphenation.
* hpfcode:                               Manipulating Hyphenation.
* hw:                                    Manipulating Hyphenation.
* hy:                                    Manipulating Hyphenation.
* hym:                                   Manipulating Hyphenation.
* hys:                                   Manipulating Hyphenation.
* ie:                                    if-else.
* if:                                    if-else.
* ig:                                    Comments.
* in:                                    Line Layout.
* it:                                    Input Line Traps.
* itc:                                   Input Line Traps.
* kern:                                  Ligatures and Kerning.
* lc:                                    Leaders.
* length:                                Strings.
* lf:                                    Debugging.
* lg:                                    Ligatures and Kerning.
* linetabs:                              Tabs and Fields.
* ll:                                    Line Layout.
* ls:                                    Manipulating Spacing.
* lt:                                    Page Layout.
* mc:                                    Miscellaneous.
* mk:                                    Page Motions.
* mso:                                   I/O.
* na:                                    Manipulating Filling and Adjusting.
* ne:                                    Page Control.
* nf:                                    Manipulating Filling and Adjusting.
* nh:                                    Manipulating Hyphenation.
* nm:                                    Miscellaneous.
* nn:                                    Miscellaneous.
* nop:                                   if-else.
* nr <1>:                                Auto-increment.
* nr:                                    Setting Registers.
* nroff:                                 Troff and Nroff Mode.
* ns:                                    Manipulating Spacing.
* nx:                                    I/O.
* open:                                  I/O.
* opena:                                 I/O.
* os:                                    Page Control.
* output:                                Diversions.
* pc:                                    Page Layout.
* pi:                                    I/O.
* pl:                                    Page Layout.
* pm:                                    Debugging.
* pn:                                    Page Layout.
* pnr:                                   Debugging.
* po:                                    Line Layout.
* ps:                                    Changing Type Sizes.
* psbb:                                  Miscellaneous.
* pso:                                   I/O.
* ptr:                                   Debugging.
* pvs:                                   Changing Type Sizes.
* rchar:                                 Using Symbols.
* rd:                                    I/O.
* return:                                Writing Macros.
* rj:                                    Manipulating Filling and Adjusting.
* rm:                                    Strings.
* rn:                                    Strings.
* rnn:                                   Setting Registers.
* rr:                                    Setting Registers.
* rs:                                    Manipulating Spacing.
* rt:                                    Page Motions.
* shc:                                   Manipulating Hyphenation.
* shift:                                 Parameters.
* sizes:                                 Changing Type Sizes.
* so:                                    I/O.
* sp:                                    Manipulating Spacing.
* special:                               Special Fonts.
* spreadwarn:                            Debugging.
* ss:                                    Manipulating Filling and Adjusting.
* sty:                                   Font Families.
* substring:                             Strings.
* sv:                                    Page Control.
* sy:                                    I/O.
* ta:                                    Tabs and Fields.
* tc:                                    Tabs and Fields.
* ti:                                    Line Layout.
* tkf:                                   Ligatures and Kerning.
* tl:                                    Page Layout.
* tm:                                    Debugging.
* tm1:                                   Debugging.
* tmc:                                   Debugging.
* tr:                                    Character Translations.
* trf:                                   I/O.
* trin:                                  Character Translations.
* trnt:                                  Character Translations.
* troff:                                 Troff and Nroff Mode.
* uf:                                    Artificial Fonts.
* ul:                                    Artificial Fonts.
* unformat:                              Diversions.
* vpt:                                   Page Location Traps.
* vs:                                    Changing Type Sizes.
* warn:                                  Debugging.
* warnscale:                             Debugging.
* wh:                                    Page Location Traps.
* while:                                 while.
* write:                                 I/O.
* writec:                                I/O.
* writem:                                I/O.


File: groff,  Node: Escape Index,  Next: Operator Index,  Prev: Request Index,  Up: Top

Escape Index
************

   Any escape sequence `\X' with X not in the list below emits a
warning, printing glyph X.

* Menu:

* <colon>:                               Manipulating Hyphenation.
* \:                                     Using Symbols.
* \!:                                    Diversions.
* \":                                    Comments.
* \#:                                    Comments.
* \$:                                    Parameters.
* \$*:                                   Parameters.
* \$0:                                   Parameters.
* \$@:                                   Parameters.
* \%:                                    Manipulating Hyphenation.
* \&:                                    Ligatures and Kerning.
* \':                                    Using Symbols.
* \):                                    Ligatures and Kerning.
* \*:                                    Strings.
* \,:                                    Ligatures and Kerning.
* \-:                                    Using Symbols.
* \.:                                    Character Translations.
* \/:                                    Ligatures and Kerning.
* \0:                                    Page Motions.
* \<RET>:                                Line Control.
* \<SP>:                                 Page Motions.
* \?:                                    Diversions.
* \\:                                    Character Translations.
* \^:                                    Page Motions.
* \`:                                    Using Symbols.
* \a:                                    Leaders.
* \A:                                    Identifiers.
* \b:                                    Drawing Requests.
* \B:                                    Expressions.
* \C:                                    Using Symbols.
* \c:                                    Line Control.
* \D:                                    Drawing Requests.
* \d:                                    Page Motions.
* \E:                                    Character Translations.
* \e:                                    Character Translations.
* \f:                                    Font Positions.
* \F:                                    Font Families.
* \f:                                    Changing Fonts.
* \g:                                    Assigning Formats.
* \h:                                    Page Motions.
* \H:                                    Artificial Fonts.
* \k:                                    Page Motions.
* \L:                                    Drawing Requests.
* \l:                                    Drawing Requests.
* \M:                                    Colors.
* \m:                                    Colors.
* \N:                                    Using Symbols.
* \n <1>:                                Auto-increment.
* \n:                                    Interpolating Registers.
* \O:                                    Suppressing output.
* \o:                                    Page Motions.
* \p:                                    Manipulating Filling and Adjusting.
* \r:                                    Page Motions.
* \R:                                    Setting Registers.
* \s:                                    Changing Type Sizes.
* \S:                                    Artificial Fonts.
* \t:                                    Tabs and Fields.
* \u:                                    Page Motions.
* \V:                                    I/O.
* \v:                                    Page Motions.
* \w:                                    Page Motions.
* \X:                                    Postprocessor Access.
* \x:                                    Manipulating Spacing.
* \Y:                                    Postprocessor Access.
* \Z:                                    Page Motions.
* \z:                                    Page Motions.
* \{:                                    if-else.
* \|:                                    Page Motions.
* \}:                                    if-else.
* \~:                                    Page Motions.


File: groff,  Node: Operator Index,  Next: Register Index,  Prev: Escape Index,  Up: Top

Operator Index
**************

* Menu:

* !:                                     Expressions.
* %:                                     Expressions.
* &:                                     Expressions.
* (:                                     Expressions.
* ):                                     Expressions.
* *:                                     Expressions.
* +:                                     Expressions.
* -:                                     Expressions.
* /:                                     Expressions.
* <:                                     Expressions.
* <=:                                    Expressions.
* <?:                                    Expressions.
* <colon>:                               Expressions.
* =:                                     Expressions.
* ==:                                    Expressions.
* >:                                     Expressions.
* >=:                                    Expressions.
* >?:                                    Expressions.


File: groff,  Node: Register Index,  Next: Macro Index,  Prev: Operator Index,  Up: Top

Register Index
**************

   The macro package or program a specific register belongs to is
appended in brackets.

   A register name `x' consisting of exactly one character can be
accessed as `\nx'.  A register name `xx' consisting of exactly two
characters can be accessed as `\n(xx'.  Register names `xxx' of any
length can be accessed as `\n[xxx]'.

* Menu:

* $$:                                    Built-in Registers.
* %:                                     Page Layout.
* .$:                                    Parameters.
* .a:                                    Manipulating Spacing.
* .A:                                    Built-in Registers.
* .b:                                    Artificial Fonts.
* .C:                                    Implementation Differences.
* .c:                                    Built-in Registers.
* .cdp:                                  Environments.
* .ce:                                   Manipulating Filling and Adjusting.
* .cht:                                  Environments.
* .color:                                Colors.
* .csk:                                  Environments.
* .d:                                    Diversions.
* .ev:                                   Environments.
* .f:                                    Font Positions.
* .F:                                    Built-in Registers.
* .fam:                                  Font Families.
* .fn:                                   Font Families.
* .fp:                                   Font Positions.
* .g:                                    Built-in Registers.
* .h:                                    Diversions.
* .H:                                    Built-in Registers.
* .hla:                                  Manipulating Hyphenation.
* .hlc:                                  Manipulating Hyphenation.
* .hlm:                                  Manipulating Hyphenation.
* .hy:                                   Manipulating Hyphenation.
* .hym:                                  Manipulating Hyphenation.
* .hys:                                  Manipulating Hyphenation.
* .i:                                    Line Layout.
* .in:                                   Line Layout.
* .int:                                  Line Control.
* .j:                                    Manipulating Filling and Adjusting.
* .k:                                    Page Motions.
* .kern:                                 Ligatures and Kerning.
* .l:                                    Line Layout.
* .L:                                    Manipulating Spacing.
* .lg:                                   Ligatures and Kerning.
* .linetabs:                             Tabs and Fields.
* .ll:                                   Line Layout.
* .lt:                                   Page Layout.
* .ne:                                   Page Location Traps.
* .ns:                                   Manipulating Spacing.
* .o:                                    Line Layout.
* .p:                                    Page Layout.
* .P:                                    Built-in Registers.
* .pn:                                   Page Layout.
* .ps:                                   Fractional Type Sizes.
* .psr:                                  Fractional Type Sizes.
* .pvs:                                  Changing Type Sizes.
* .rj:                                   Manipulating Filling and Adjusting.
* .s:                                    Changing Type Sizes.
* .sr:                                   Fractional Type Sizes.
* .ss:                                   Manipulating Filling and Adjusting.
* .sss:                                  Manipulating Filling and Adjusting.
* .t:                                    Page Location Traps.
* .T:                                    Built-in Registers.
* .tabs:                                 Tabs and Fields.
* .trunc:                                Page Location Traps.
* .u:                                    Manipulating Filling and Adjusting.
* .v:                                    Changing Type Sizes.
* .V:                                    Built-in Registers.
* .vpt:                                  Page Location Traps.
* .warn:                                 Debugging.
* .x:                                    Built-in Registers.
* .Y:                                    Built-in Registers.
* .y:                                    Built-in Registers.
* .z:                                    Diversions.
* c.:                                    Built-in Registers.
* ct:                                    Page Motions.
* dl:                                    Diversions.
* dn:                                    Diversions.
* dw:                                    Built-in Registers.
* dy:                                    Built-in Registers.
* FF [ms]:                               ms Document Control Registers.
* FI [ms]:                               ms Document Control Registers.
* FL [ms]:                               ms Document Control Registers.
* FM [ms]:                               ms Document Control Registers.
* HM [ms]:                               ms Document Control Registers.
* hours:                                 Built-in Registers.
* hp:                                    Page Motions.
* LL [ms]:                               ms Document Control Registers.
* llx:                                   Miscellaneous.
* lly:                                   Miscellaneous.
* ln:                                    Built-in Registers.
* LT [ms]:                               ms Document Control Registers.
* MINGW [ms] <1>:                        Additional ms Macros.
* MINGW [ms]:                            ms Document Control Registers.
* minutes:                               Built-in Registers.
* mo:                                    Built-in Registers.
* nl:                                    Page Control.
* opmaxx:                                Suppressing output.
* opmaxy:                                Suppressing output.
* opminx:                                Suppressing output.
* opminy:                                Suppressing output.
* PD [ms]:                               ms Document Control Registers.
* PI [ms]:                               ms Document Control Registers.
* PO [ms]:                               ms Document Control Registers.
* PS [ms]:                               ms Document Control Registers.
* ps4html [grohtml]:                     grohtml specific registers and strings.
* QI [ms]:                               ms Document Control Registers.
* rsb:                                   Page Motions.
* rst:                                   Page Motions.
* sb:                                    Page Motions.
* seconds:                               Built-in Registers.
* skw:                                   Page Motions.
* slimit:                                Debugging.
* ssc:                                   Page Motions.
* st:                                    Page Motions.
* systat:                                I/O.
* urx:                                   Miscellaneous.
* ury:                                   Miscellaneous.
* VS [ms]:                               ms Document Control Registers.
* year:                                  Built-in Registers.
* yr:                                    Built-in Registers.


File: groff,  Node: Macro Index,  Next: String Index,  Prev: Register Index,  Up: Top

Macro Index
***********

   The macro package a specific macro belongs to is appended in
brackets.  They appear without the leading control character (normally
`.').

* Menu:

* 1C [ms]:                               ms Multiple Columns.
* 2C [ms]:                               ms Multiple Columns.
* [ [ms]:                                ms Insertions.
* ] [ms]:                                ms Insertions.
* AB [ms]:                               ms Cover Page Macros.
* AE [ms]:                               ms Cover Page Macros.
* AI [ms]:                               ms Cover Page Macros.
* AM [ms] <1>:                           Additional ms Macros.
* AM [ms]:                               ms Strings and Special Characters.
* AU [ms]:                               ms Cover Page Macros.
* B [man]:                               Man font macros.
* B [ms]:                                Highlighting in ms.
* B1 [ms]:                               ms Displays and Keeps.
* B2 [ms]:                               ms Displays and Keeps.
* BD [ms]:                               ms Displays and Keeps.
* BI [man]:                              Man font macros.
* BI [ms]:                               Highlighting in ms.
* BR [man]:                              Man font macros.
* BX [ms]:                               Highlighting in ms.
* CD [ms]:                               ms Displays and Keeps.
* CW [ms] <1>:                           Additional ms Macros.
* CW [ms]:                               Highlighting in ms.
* DA [ms]:                               ms Cover Page Macros.
* DE [ms]:                               ms Displays and Keeps.
* DS [ms] <1>:                           Additional ms Macros.
* DS [ms]:                               ms Displays and Keeps.
* DT [man]:                              Miscellaneous man macros.
* EF [ms]:                               ms Headers and Footers.
* EH [ms]:                               ms Headers and Footers.
* EN [ms]:                               ms Insertions.
* EQ [ms]:                               ms Insertions.
* FE [ms]:                               ms Footnotes.
* FS [ms]:                               ms Footnotes.
* HP [man]:                              Man usage.
* I [man]:                               Man font macros.
* I [ms]:                                Highlighting in ms.
* IB [man]:                              Man font macros.
* ID [ms]:                               ms Displays and Keeps.
* IP [man]:                              Man usage.
* IP [ms]:                               Lists in ms.
* IR [man]:                              Man font macros.
* IX [ms]:                               Additional ms Macros.
* KE [ms]:                               ms Displays and Keeps.
* KF [ms]:                               ms Displays and Keeps.
* KS [ms]:                               ms Displays and Keeps.
* LD [ms]:                               ms Displays and Keeps.
* LG [ms]:                               Highlighting in ms.
* LP [man]:                              Man usage.
* LP [ms]:                               Paragraphs in ms.
* MC [ms]:                               ms Multiple Columns.
* ND [ms]:                               ms Cover Page Macros.
* NH [ms]:                               Headings in ms.
* NL [ms]:                               Highlighting in ms.
* OF [ms]:                               ms Headers and Footers.
* OH [ms]:                               ms Headers and Footers.
* P [man]:                               Man usage.
* PD [man]:                              Miscellaneous man macros.
* PE [ms]:                               ms Insertions.
* PP [man]:                              Man usage.
* PP [ms]:                               Paragraphs in ms.
* PS [ms]:                               ms Insertions.
* PX [ms]:                               ms TOC.
* QP [ms]:                               Paragraphs in ms.
* R [ms]:                                Highlighting in ms.
* RB [man]:                              Man font macros.
* RD [ms]:                               ms Displays and Keeps.
* RE [man]:                              Man usage.
* RE [ms]:                               Indents in ms.
* RI [man]:                              Man font macros.
* RP [ms]:                               ms Cover Page Macros.
* RS [man]:                              Man usage.
* RS [ms]:                               Indents in ms.
* SB [man]:                              Man font macros.
* SH [man]:                              Man usage.
* SH [ms]:                               Headings in ms.
* SM [man]:                              Man font macros.
* SM [ms]:                               Highlighting in ms.
* SS [man]:                              Man usage.
* TA [ms]:                               Tabstops in ms.
* TC [ms]:                               ms TOC.
* TE [ms]:                               ms Insertions.
* TH [man]:                              Man usage.
* TL [ms]:                               ms Cover Page Macros.
* TP [man]:                              Man usage.
* TS [ms]:                               ms Insertions.
* UL [ms]:                               Highlighting in ms.
* XA [ms]:                               ms TOC.
* XE [ms]:                               ms TOC.
* XP [ms]:                               Paragraphs in ms.
* XS [ms]:                               ms TOC.

OpenPOWER on IntegriCloud