texinfo (7.1)
This is texinfo.info, produced by texi2any version 7.1 from
texinfo.texi.
This manual is for GNU Texinfo (version 7.1, 18 October 2023), a
documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright © 1988-2023 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.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts, and
no Back-Cover Texts. A copy of the license is included in the
section entitled "GNU Free Documentation License".
INFO-DIR-SECTION Texinfo documentation system
START-INFO-DIR-ENTRY
* Texinfo: (texinfo). The GNU documentation format.
* install-info: (texinfo)Invoking install-info. Update info/dir entries.
* texi2any: (texinfo)Invoking texi2any. Translate Texinfo source.
* makeinfo: (texinfo)Invoking texi2any. Translate Texinfo source.
* pod2texi: (pod2texi)Invoking pod2texi. Translate Perl Pod to Texinfo.
* texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents.
* texi2pdf: (texinfo)PDF Output. PDF output for Texinfo.
* pdftexi2dvi: (texinfo)PDF Output. PDF output for Texinfo.
* texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files.
END-INFO-DIR-ENTRY
Indirect:
texinfo.info-1: 1465
texinfo.info-2: 301545
texinfo.info-3: 601515
Tag Table:
(Indirect)
Node: Top1465
Node: Copying Conditions27853
Node: Overview29766
Ref: Using Texinfo29918
Node: Reporting Bugs32593
Node: Output Formats34079
Node: Info Files39546
Node: Printed Books41571
Node: Adding Output Formats42812
Node: History45326
Ref: Reference Implementation50528
Node: Writing a Texinfo File51394
Ref: Beginning and Ending a File51488
Node: Conventions52428
Ref: Formatting Commands52585
Node: Comments55700
Node: Minimum57532
Ref: Minimum-Footnote-159352
Node: Short Sample Texinfo File59547
Ref: Short Sample59676
Ref: Sample Beginning59676
Node: Texinfo File Header60956
Node: First Line62868
Node: @setfilename63976
Ref: setfilename64181
Ref: Setting the Output File Name64181
Node: @settitle67051
Ref: settitle67244
Node: Preamble68511
Node: Start and End of Header70692
Ref: Start of Header70870
Ref: End of Header71469
Node: Directory Category71983
Node: Document Permissions72925
Ref: Software Copying Permissions73067
Node: @copying74360
Ref: copying74546
Node: @insertcopying77157
Ref: insertcopying77349
Node: Titlepage & Copyright Page78603
Node: @titlepage80181
Ref: titlepage80331
Ref: @titlepage-Footnote-182736
Node: @title @subtitle @author83023
Ref: title subtitle author83260
Node: @titlefont @center @sp85460
Ref: titlefont center sp85692
Node: Copyright86996
Node: Heading Generation88929
Ref: end titlepage89080
Node: Contents90133
Node: The Top Node92324
Ref: Top Node Example92519
Node: Master Menu Parts93575
Node: The Body of the Document95315
Node: Ending a File97009
Ref: File End97428
Node: Nodes97573
Ref: node97695
Ref: @node97695
Node: Writing a Node99631
Node: Node Names102638
Ref: Node Line Tips102904
Node: Node Line Requirements105068
Ref: Info Node Names Constraints106669
Ref: Node Line Requirements-Footnote-1108766
Node: First Node108954
Node: @top Command111170
Ref: top command111352
Ref: makeinfo top111352
Ref: makeinfo top command111352
Node: Texinfo Document Structure112240
Ref: Two Paths112424
Node: Node Menu Illustration115307
Node: Node Descriptions119423
Node: Menus121287
Node: Writing a Menu122693
Node: Menu Example124580
Node: Menu Location126108
Node: Menu Parts127013
Node: Less Cluttered Menu Entry128712
Node: Other Info Files129333
Node: Chapter Structuring130769
Ref: Structuring130913
Node: Tree Structuring131806
Node: Structuring Command Types133344
Node: @chapter136586
Ref: chapter136792
Node: @unnumbered @appendix137235
Ref: unnumbered & appendix137496
Node: @majorheading @chapheading138657
Ref: majorheading & chapheading138916
Node: @section139569
Ref: section139799
Node: @unnumberedsec @appendixsec @heading140505
Ref: unnumberedsec appendixsec heading140746
Node: @subsection142010
Ref: subsection142274
Node: @unnumberedsubsec @appendixsubsec @subheading142462
Ref: unnumberedsubsec appendixsubsec subheading142684
Node: @subsubsection143582
Ref: subsubsection143822
Node: @part144919
Node: Raise/lower sections147297
Node: Cross References149485
Node: Cross Reference Commands152317
Node: Cross Reference Parts153475
Ref: Reference Syntax153667
Node: One Argument156650
Node: Two Arguments157108
Node: Three Arguments157846
Node: Four and Five Arguments160121
Node: Referring to a Manual as a Whole163498
Ref: Top Node Naming163705
Node: @xref165397
Ref: xref165539
Node: @ref165682
Ref: ref165796
Node: @pxref166786
Ref: pxref166908
Node: @anchor167914
Ref: anchor168127
Node: @link169946
Node: @inforef171217
Ref: inforef171423
Node: @url172095
Ref: uref172291
Ref: url172291
Node: @url Examples173594
Node: URL Line Breaking175223
Node: @url PDF Output Format176481
Node: @cite177564
Ref: cite177708
Node: PDF Colors178105
Node: Marking Text179399
Node: Indicating180062
Node: Useful Highlighting181550
Node: @code183283
Ref: code183436
Node: @kbd187054
Ref: kbd187206
Node: @key189086
Ref: key189216
Node: @samp190523
Ref: samp190648
Node: @verb192061
Ref: verb192202
Node: @var193384
Ref: var193542
Ref: @var-Footnote-1195203
Node: @env195648
Ref: env195802
Node: @file196188
Ref: file196326
Node: @command196833
Ref: command196988
Node: @option197586
Ref: option197736
Node: @dfn198061
Ref: dfn198188
Node: @abbr199020
Ref: abbr199188
Node: @acronym200469
Ref: acronym200641
Node: @indicateurl203281
Ref: indicateurl203474
Node: @email204052
Ref: email204230
Node: Emphasis204975
Node: @emph @strong205814
Ref: emph & strong205980
Node: Smallcaps206943
Node: Fonts208188
Node: Quotations and Examples210886
Node: Block Enclosing Commands212720
Node: @quotation215126
Ref: quotation215328
Node: @indentedblock217540
Node: @example218376
Ref: example218549
Node: @verbatim220739
Ref: verbatim220905
Node: @lisp222744
Ref: lisp222922
Node: @display223376
Ref: display223570
Node: @format223992
Ref: format224198
Node: @exdent224803
Ref: exdent225011
Node: @flushleft @flushright226000
Ref: flushleft & flushright226201
Node: @raggedright227320
Ref: raggedright227525
Node: @noindent228731
Ref: noindent228921
Node: @indent230627
Ref: indent230809
Node: @cartouche231808
Ref: cartouche231990
Node: small233514
Node: Lists and Tables235374
Node: Introducing Lists236056
Node: @itemize237776
Ref: itemize237968
Node: @enumerate240541
Ref: enumerate240759
Node: Two-column Tables243056
Node: @table243751
Ref: table243907
Ref: @asis244560
Node: @ftable @vtable246775
Ref: ftable vtable246944
Node: @itemx247951
Ref: itemx248129
Node: Multi-column Tables249257
Node: Multitable Column Widths249986
Node: Multitable Rows251783
Node: Special Displays254265
Node: Floats255051
Node: @float255948
Ref: float256132
Ref: fig:ex1256650
Node: @caption @shortcaption258418
Ref: caption shortcaption258600
Node: @listoffloats260306
Ref: listoffloats260505
Node: Images262116
Node: Image Syntax262553
Node: Image Scaling266392
Node: Footnotes268171
Ref: Footnotes-Footnote-1268785
Node: Footnote Commands269070
Ref: Footnote Commands-Footnote-1271308
Node: Footnote Styles271345
Node: Indices273973
Node: Predefined Indices275302
Node: Indexing Commands277599
Node: Advanced Indexing280707
Node: Index Entries282946
Node: Printing Indices & Menus285465
Node: Combining Indices287898
Node: @syncodeindex289270
Ref: syncodeindex289477
Node: @synindex291044
Ref: synindex291211
Node: New Indices291641
Node: Insertions294079
Node: Special Characters295168
Ref: Braces Atsign295366
Ref: Atsign Braces Comma295366
Node: Inserting an Atsign296130
Node: Inserting Braces296756
Node: Inserting a Comma297517
Node: Inserting a Backslash298809
Node: Inserting a Hashsign301545
Node: Inserting an Ampersand302827
Ref: Inserting an Ampersand-Footnote-1304314
Node: Inserting Quote Characters304414
Node: Inserting Space306318
Node: Multiple Spaces306902
Node: Not Ending a Sentence307947
Node: Ending a Sentence309805
Node: @frenchspacing312428
Ref: frenchspacing312647
Node: @dmn313754
Ref: dmn313929
Node: Inserting Accents314881
Node: Inserting Quotation Marks317680
Node: Inserting Subscripts and Superscripts321335
Node: Inserting Math322315
Ref: math322568
Node: Glyphs for Text325448
Ref: Glyphs325608
Ref: TeX and copyright325608
Node: @TeX @LaTeX326547
Ref: tex326729
Node: @copyright327261
Ref: copyright symbol327428
Node: @registeredsymbol327719
Ref: registered symbol327894
Node: @dots328060
Ref: dots328253
Ref: Dots Bullets328253
Node: @bullet329080
Ref: bullet329217
Node: @euro329518
Ref: euro329697
Node: @pounds330233
Ref: pounds330409
Node: @textdegree330565
Ref: textdegree330748
Node: @minus330889
Ref: minus331081
Node: @geq @leq331627
Ref: geq leq331827
Node: Glyphs for Programming332046
Node: Glyphs Summary333308
Node: @result334054
Ref: result334266
Node: @expansion334631
Ref: expansion334841
Node: @print335676
Ref: Print Glyph335885
Node: @error336633
Ref: Error Glyph336848
Node: @equiv337614
Ref: Equivalence337809
Node: @point338426
Ref: Point Glyph338642
Node: Click Sequences340068
Node: Inserting Unicode341131
Node: Breaks343015
Node: Break Commands344436
Node: Line Breaks345342
Node: @- @hyphenation346129
Ref: - and hyphenation346362
Node: @allowcodebreaks347535
Ref: allowcodebreaks347751
Node: @w348785
Ref: w348948
Node: @tie349979
Ref: tie350147
Node: @sp350926
Ref: sp351071
Node: @page351320
Ref: page351463
Node: @group351729
Ref: group351882
Node: @need352796
Ref: need352945
Node: Definition Commands353574
Node: Def Cmd Template354956
Node: Def Cmd Continuation Lines357300
Node: Optional Arguments358942
Node: No Space After Definition Name360257
Node: @deffnx360935
Ref: deffnx361170
Node: Def Cmds in Detail361815
Node: Functions Commands362518
Node: Typed Functions365230
Node: Variables Commands369741
Node: Typed Variables371662
Node: Data Types373193
Node: Abstract Objects374392
Node: Object-Oriented Variables375001
Node: Object-Oriented Methods377437
Node: Generic Definition Commands381466
Node: Def Cmd Conventions383219
Node: Sample Function Definition385567
Node: Internationalization388280
Node: @documentlanguage388938
Ref: documentlanguage389164
Node: @documentencoding392013
Ref: documentencoding392217
Ref: @documentencoding-Footnote-1396787
Node: Conditionals397047
Node: Conditional Commands398426
Node: Conditional Not Commands401360
Node: Raw Formatter Commands402712
Node: Inline Conditionals405509
Node: @set @clear @value407510
Ref: set clear value407770
Node: @set @value408986
Ref: set value409140
Node: @ifset @ifclear411087
Ref: ifset ifclear411285
Node: @inlineifset @inlineifclear413282
Node: @value Example414117
Ref: value Example414276
Node: Testing for Texinfo Commands416300
Node: Conditional Nesting418938
Node: Defining New Texinfo Commands419710
Node: Defining Macros421597
Node: Invoking Macros424043
Node: Macro Details427767
Node: @alias434677
Ref: alias434851
Node: Line Macros436457
Node: @definfoenclose439211
Ref: definfoenclose439448
Node: External Macro Processors441761
Node: #line Directive443074
Node: #line and TeX444585
Node: #line Syntax Details445979
Node: Include Files447277
Node: Using Include Files448012
Node: Sample Include File449520
Node: @verbatiminclude450521
Ref: verbatiminclude450729
Node: Hardcopy with TeX451731
Ref: Hardcopy451920
Ref: Printing451920
Ref: Within Emacs452531
Ref: Emacs Shell Printing452531
Node: Use TeX453535
Ref: Obtaining TeX453948
Node: Format with texi2dvi or texi2pdf454242
Ref: PDF Output454471
Ref: Format with texi2dvi454471
Ref: Format with texi2dvi or texi2pdf-Footnote-1460233
Node: Format with tex/texindex460386
Ref: Names of index files461422
Node: Formatting Partial Documents464193
Node: Details of texindex465331
Node: Print with lpr466604
Node: Preparing for TeX467957
Node: Overfull hboxes470884
Node: Generic Translator texi2any473014
Node: Invoking texi2any474774
Ref: Invoking makeinfo474976
Ref: makeinfo Options475416
Ref: texi2any Options475416
Ref: Pointer Validation484992
Ref: Splitting Output489889
Node: texi2any Environment Variables491795
Node: texi2any Printed Output494276
Node: Customization Variables496523
Node: Customization Variables for @-Commands498325
Node: Customization Variables and Options500198
Node: HTML Customization Variables504081
Node: MathJax Customization Variables520324
Node: latex2html Customization Variables521758
Node: tex4ht Customization Variables523528
Node: LaTeX Customization Variables524806
Node: Other Customization Variables526847
Ref: NO_TOP_NODE_OUTPUT536674
Node: Internationalization of Document Strings547098
Node: Invoking pod2texi551508
Node: pod2texi manual page552619
Ref: pod2texi552727
Ref: pod2texi NAME552756
Ref: pod2texi SYNOPSIS552828
Ref: pod2texi DESCRIPTION552902
Ref: pod2texi OPTIONS553282
Ref: pod2texi *--appendix-sections*553304
Ref: pod2texi *--base-level*=_NUM|NAME_553505
Ref: pod2texi *--debug*=_NUM_554455
Ref: pod2texi *--headings-as-sections*554517
Ref: pod2texi *--help*554818
Ref: pod2texi *--menus*554858
Ref: pod2texi *--output*=_NAME_555065
Ref: pod2texi *--no-section-nodes*555212
Ref: pod2texi *--no-fill-section-gaps*555287
Ref: pod2texi *--preamble*=_STR_555445
Ref: pod2texi *--setfilename*=_STR_555701
Ref: pod2texi *--subdir*=_NAME_555863
Ref: pod2texi *--unnumbered-sections*556046
Ref: pod2texi *--top*=_TOP_556239
Ref: pod2texi *--version*556342
Ref: pod2texi SEE ALSO556424
Ref: pod2texi COPYRIGHT AND LICENSE556617
Ref: pod2texi AUTHOR557004
Node: texi2html557042
Node: Creating and Installing Info Files560043
Ref: Creating an Info File560255
Node: Installing an Info File560732
Node: Directory File561564
Node: New Info File563525
Ref: New Info File-Footnote-1564677
Node: Other Info Directories564763
Node: Installing Dir Entries567978
Node: Invoking install-info570744
Node: Tag and Split Files577773
Node: Info Format FAQ580955
Node: Generating HTML585661
Node: HTML Translation587302
Node: HTML Splitting589438
Node: HTML CSS591747
Node: @documentdescription595439
Ref: documentdescription595642
Node: Generating EPUB596199
Node: EPUB Output File and Directory597495
Node: EPUB Cross-References599319
Node: EPUB HTML601515
Node: Syntax Highlighting602745
Node: HTML Xref603878
Node: HTML Xref Link Basics605094
Node: HTML Xref Node Name Expansion608474
Node: HTML Xref Command Expansion611451
Node: HTML Xref 8-bit Character Expansion614774
Node: HTML Xref Mismatch617227
Node: HTML Xref Configuration618976
Node: @-Command Details622995
Node: Command Syntax623378
Node: Command List626838
Node: Command Contexts674604
Node: Obsolete @-Commands676557
Node: Tips677751
Ref: texi-elements-by-size687632
Node: Sample Texinfo Files689485
Node: GNU Sample Texts689797
Node: Verbatim Copying License693880
Node: All-permissive Copying License694984
Node: Texinfo Mode696027
Node: Texinfo Mode Overview697281
Node: Emacs Editing698072
Node: Inserting699957
Node: Showing the Structure705047
Node: Using texinfo-show-structure707610
Node: Using occur710810
Node: Updating Nodes and Menus712392
Node: Updating Commands714046
Node: Updating Requirements720629
Node: Update Multiple Files722514
Ref: texinfo-multiple-files-update722747
Node: Include Files Requirements725298
Node: Other Updating Commands726592
Node: Info Formatting729331
Node: texi2any in Emacs729831
Ref: makeinfo in Emacs730040
Ref: makeinfo Advantages730040
Node: texinfo-format commands732651
Node: Printing with Emacs734122
Node: Texinfo Mode Printing734649
Node: Compile-Command740073
Node: Texinfo Mode Summary740955
Node: Formatting Info files745871
Node: Tagifying747213
Node: Splitting748113
Node: Catching Mistakes749467
Node: texi2any Preferred750546
Ref: makeinfo Preferred750708
Node: Debugging with Info751351
Node: Debugging with TeX754783
Node: Running Info-validate759094
Ref: Running Info-Validate759274
Node: Using Info-validate760588
Node: Unsplit and Tagify762504
Ref: Unsplit762724
Node: Batch Formatting764336
Node: Global Document Commands765513
Node: @setchapternewpage766602
Ref: setchapternewpage766812
Node: Headings769520
Ref: Headings Introduced769679
Node: @headings771026
Ref: headings on off771169
Node: Heading Format772535
Node: Custom Headings774605
Node: @paragraphindent780332
Ref: paragraphindent780578
Node: @firstparagraphindent781518
Ref: firstparagraphindent781762
Node: @exampleindent782820
Ref: exampleindent783038
Node: @smallbook784028
Ref: smallbook784227
Node: A4 Paper785021
Node: @pagesizes785777
Ref: pagesizes786003
Node: Microtypography786899
Node: Magnification788183
Ref: Cropmarks and Magnification788321
Node: Info Format Specification789433
Node: Info Format Whole Manual791516
Node: Info Format Preamble792736
Node: Info Format Indirect Table793711
Node: Info Format Tag Table795280
Node: Info Format Local Variables796902
Node: Info Format Regular Nodes797390
Node: Info Format Menu799462
Node: Info Format Image800405
Node: Info Format Printindex801680
Node: Info Format Cross Reference803147
Node: GNU Free Documentation License805818
Node: Command and Variable Index831004
Node: General Index874606
End Tag Table
Local Variables:
coding: utf-8
End: