Texinfo

The GNU Documentation Format

for Texinfo version 4.0, 9 February 2000

• Texinfo Copying Conditions
• 1. Overview of Texinfo
  • 1.1 Reporting Bugs
  • 1.2 Using Texinfo
  • 1.3 Info files
  • 1.4 Printed Books
  • 1.5 @-commands
  • 1.6 General Syntactic Conventions
  • 1.7 Comments
  • 1.8 What a Texinfo File Must Have
  • 1.9 Six Parts of a Texinfo File
  • 1.10 A Short Sample Texinfo File
  • 1.11 Acknowledgements and History
• 2. Using Texinfo Mode
  • 2.2 The Usual GNU Emacs Editing Commands
  • 2.3 Inserting Frequently Used Commands
  • 2.4 Showing the Section Structure of a File
  • 2.5 Updating Nodes and Menus
    • 2.5.2 Updating Requirements
    • 2.5.3 Other Updating Commands
  • 2.6 Formatting for Info
  • 2.7 Formatting and Printing
  • 2.8 Texinfo Mode Summary
• 3. Beginning a Texinfo File
  • 3.2 Sample Texinfo File Beginning
  • 3.3 The Texinfo File Header
    • 3.3.1 The First Line of a Texinfo File
    • 3.3.2 Start of Header
    • 3.3.3 @setfilename
    • 3.3.4 @settitle
    • 3.3.5 @setchapternewpage
    • 3.3.6 Paragraph Indenting
    • 3.3.7 @exampleindent: Environment Indenting
    • 3.3.8 End of Header
  • 3.4 Summary and Copying Permissions for Info
  • 3.5 The Title and Copyright Pages
    • 3.5.1 @titlepage
    • 3.5.2 @titlefont, @center, and @sp
    • 3.5.3 @title, @subtitle, and @author
    • 3.5.4 Copyright Page and Permissions
    • 3.5.5 Heading Generation
    • 3.5.6 The @headings Command
  • 3.6 The `Top' Node and Master Menu
    • 3.6.1 `Top' Node Title
    • 3.6.2 Parts of a Master Menu
  • 3.7 Software Copying Permissions
• 4. Ending a Texinfo File
  • 4.1 Index Menus and Printing an Index
  • 4.2 Generating a Table of Contents
  • 4.3 @bye File Ending
• 5. Chapter Structuring
  • 5.1 Tree Structure of Sections
  • 5.2 Structuring Command Types
  • 5.3 @top
  • 5.4 @chapter
  • 5.5 @unnumbered and @appendix
  • 5.6 @majorheading, @chapheading
  • 5.7 @section
  • 5.8 @unnumberedsec, @appendixsec, @heading
  • 5.9 The @subsection Command
  • 5.10 The @subsection-like Commands
  • 5.11 The `subsub' Commands
  • 5.12 @raisesections and @lowersections
• 6. Nodes
  • 6.1 Two Paths
  • 6.2 Node and Menu Illustration
  • 6.3 The @node Command
    • 6.3.1 Choosing Node and Pointer Names
    • 6.3.2 How to Write an @node Line
    • 6.3.3 @node Line Tips
    • 6.3.4 @node Line Requirements
    • 6.3.5 The First Node
    • 6.3.6 The @top Sectioning Command
    • 6.3.7 The `Top' Node Summary
  • 6.4 Creating Pointers with makeinfo
  • 6.5 @anchor: Defining Arbitrary Cross-reference Targets
• 7. Menus
  • 7.2 Writing a Menu
  • 7.3 The Parts of a Menu
  • 7.4 Less Cluttered Menu Entry
  • 7.5 A Menu Example
  • 7.6 Referring to Other Info Files
• 8. Cross References
  • 8.2 Different Cross Reference Commands
  • 8.3 Parts of a Cross Reference
  • 8.4 @xref
    • 8.4.2 @xref with One Argument
    • 8.4.3 @xref with Two Arguments
    • 8.4.4 @xref with Three Arguments
    • 8.4.5 @xref with Four and Five Arguments
  • 8.5 Naming a `Top' Node
  • 8.6 @ref
  • 8.7 @pxref
  • 8.8 @inforef
  • 8.9 @uref{url[, text][, replacement]}
• 9. Marking Words and Phrases
  • 9.1 Indicating Definitions, Commands, etc.
    • 9.1.2 @code{sample-code}
    • 9.1.3 @kbd{keyboard-characters}
    • 9.1.4 @key{key-name}
    • 9.1.5 @samp{text}
    • 9.1.6 @var{metasyntactic-variable}
    • 9.1.7 @env{environment-variable}
    • 9.1.8 @file{file-name}
    • 9.1.9 @command{command-name}
    • 9.1.10 @option{option-name}
    • 9.1.11 @dfn{term}
    • 9.1.12 @cite{reference}
    • 9.1.13 @acronym{acronym}
    • 9.1.14 @url{uniform-resource-locator}
    • 9.1.15 @email{email-address[, displayed-text]}
  • 9.2 Emphasizing Text
    • 9.2.1 @emph{text} and @strong{text}
    • 9.2.2 @sc{text}: The Small Caps Font
    • 9.2.3 Fonts for Printing, Not Info
• 10. Quotations and Examples
  • 10.1 Block Enclosing Commands
  • 10.2 @quotation
  • 10.3 @example
  • 10.4 @noindent
  • 10.5 @lisp
  • 10.6 @small... Block Commands
  • 10.7 @display and @smalldisplay
  • 10.8 @format and @smallformat
  • 10.9 @exdent: Undoing a Line's Indentation
  • 10.10 @flushleft and @flushright
  • 10.11 Drawing Cartouches Around Examples
• 11. Lists and Tables
  • 11.2 @itemize: Making an Itemized List
  • 11.3 @enumerate: Making a Numbered or Lettered List
  • 11.4 Making a Two-column Table
    • 11.4.2 @ftable and @vtable
    • 11.4.3 @itemx
  • 11.5 Multi-column Tables
    • 11.5.1 Multitable Column Widths
    • 11.5.2 Multitable Rows
• 12. Indices
  • 12.1 Making Index Entries
  • 12.2 Predefined Indices
  • 12.3 Defining the Entries of an Index
  • 12.4 Combining Indices
    • 12.4.1 @syncodeindex
    • 12.4.2 @synindex
  • 12.5 Defining New Indices
• 13. Special Insertions
  • 13.1 Inserting @ and Braces
    • 13.1.1 Inserting `@' with @@
    • 13.1.2 Inserting `{' and `}'with @{ and @}
  • 13.2 Inserting Space
    • 13.2.1 Not Ending a Sentence
    • 13.2.2 Ending a Sentence
    • 13.2.3 Multiple Spaces
    • 13.2.4 @dmn{dimension}: Format a Dimension
  • 13.3 Inserting Accents
  • 13.4 Inserting Ellipsis and Bullets
    • 13.4.1 @dots{} (...) and @enddots{} (@enddots{})
    • 13.4.2 @bullet{} (*)
  • 13.5 Inserting TeX and the Copyright Symbol
    • 13.5.1 @TeX{} (TeX)
    • 13.5.2 @copyright{} ((C))
  • 13.6 @pounds{} (@pounds{}): Pounds Sterling
  • 13.7 @minus{} (-): Inserting a Minus Sign
  • 13.8 @math: Inserting Mathematical Expressions
  • 13.9 Glyphs for Examples
    • 13.9.2 @result{} (=>): Indicating Evaluation
    • 13.9.3 @expansion{} (==>): Indicating an Expansion
    • 13.9.4 @print{} (-|): Indicating Printed Output
    • 13.9.5 @error{} (error-->): Indicating an Error Message
    • 13.9.6 @equiv{} (==): Indicating Equivalence
    • 13.9.7 @point{} (-!-): Indicating Point in a Buffer
  • 13.10 Footnotes
    • 13.10.1 Footnote Commands
    • 13.10.2 Footnote Styles
  • 13.11 Inserting Images
• 14. Making and Preventing Breaks
  • 14.2 @*: Generate Line Breaks
  • 14.3 @- and @hyphenation: Helping TeX hyphenate
  • 14.4 @w{text}: Prevent Line Breaks
  • 14.5 @sp n: Insert Blank Lines
  • 14.6 @page: Start a New Page
  • 14.7 @group: Prevent Page Breaks
  • 14.8 @need mils: Prevent Page Breaks
• 15. Definition Commands
  • 15.1 The Template for a Definition
  • 15.2 Optional and Repeated Arguments
  • 15.3 Two or More `First' Lines
  • 15.4 The Definition Commands
    • 15.4.1 Functions and Similar Entities
    • 15.4.2 Variables and Similar Entities
    • 15.4.3 Functions in Typed Languages
    • 15.4.4 Variables in Typed Languages
    • 15.4.5 Object-Oriented Programming
    • 15.4.6 Data Types
  • 15.5 Conventions for Writing Definitions
  • 15.6 A Sample Function Definition
• 16. Conditionally Visible Text
  • 16.1 Conditional Commands
  • 16.2 Conditional Not Commands
  • 16.3 Raw Formatter Commands
  • 16.4 @set, @clear, and @value
    • 16.4.1 @ifset and @ifclear
    • 16.4.2 @set and @value
    • 16.4.3 @value Example
• 17. Internationalization
  • 17.1 @documentlanguage cc: Set the Document Language
  • 17.2 @documentencoding enc: Set Input Encoding
• 18. Defining New Texinfo Commands
  • 18.1 Defining Macros
  • 18.2 Invoking Macros
  • 18.3 Macro Details
  • 18.4 `@alias new=existing'
  • 18.5 `definfoenclose': Customized Highlighting
• 19. Formatting and Printing Hardcopy
  • 19.1 Use TeX
  • 19.2 Format with tex and texindex
  • 19.3 Format with texi2dvi
  • 19.4 Shell Print Using lpr -d
  • 19.5 From an Emacs Shell
  • 19.6 Formatting and Printing in Texinfo Mode
  • 19.7 Using the Local Variables List
  • 19.8 TeX Formatting Requirements Summary
  • 19.9 Preparing for TeX
  • 19.10 Overfull "hboxes"
  • 19.11 Printing "Small" Books
  • 19.12 Printing on A4 Paper
  • 19.13 @pagesizes [width][, height]: Custom page sizes
  • 19.14 Cropmarks and Magnification
  • 19.15 PDF Output
• 20. Creating and Installing Info Files
  • 20.1 Creating an Info File
    • 20.1.1 makeinfo Preferred
    • 20.1.2 Running makeinfo from a Shell
    • 20.1.3 Options for makeinfo
    • 20.1.4 Pointer Validation
    • 20.1.5 Running makeinfo inside Emacs
    • 20.1.6 The texinfo-format... Commands
    • 20.1.7 Batch Formatting
    • 20.1.8 Tag Files and Split Files
    • 20.1.9 Generating HTML
  • 20.2 Installing an Info File
    • 20.2.1 The Directory File `dir'
    • 20.2.2 Listing a New Info File
    • 20.2.3 Info Files in Other Directories
    • 20.2.4 Installing Info Directory Files
    • 20.2.5 Invoking install-info
• A. @-Command List
• B. Tips and Hints
• C. A Sample Texinfo File
• D. Sample Permissions
  • 20.3 Inserting Permissions
  • 20.4 `ifinfo' Copying Permissions
  • 20.5 Titlepage Copying Permissions
• E. Include Files
  • 20.6 How to Use Include Files
  • 20.7 texinfo-multiple-files-update
  • 20.8 Include File Requirements
  • 20.9 Sample File with @include
  • 20.10 Evolution of Include Files
• F. Page Headings
  • 20.12 Standard Heading Formats
  • 20.13 Specifying the Type of Heading
  • 20.14 How to Make Your Own Headings
• G. Formatting Mistakes
  • 20.16 Catching Errors with Info Formatting
  • 20.17 Catching Errors with TeX Formatting
  • 20.18 Using texinfo-show-structure
  • 20.19 Using occur
  • 20.20 Finding Badly Referenced Nodes
    • 20.20.1 Running Info-validate
    • 20.20.2 Creating an Unsplit File
    • 20.20.3 Tagifying a File
    • 20.20.4 Splitting a File Manually
• H. Refilling Paragraphs
• I. @-Command Syntax
• J. How to Obtain TeX
• Command and Variable Index
• Concept Index

This document was generated on 1 July 2000 using texi2html 1.56k.