Texinfo

The GNU Documentation Format

Edition 2.16, for Texinfo Version Two

October 1992

by Robert J. Chassell and Richard M. Stallman

Texinfo Copying Conditions
Overview of Texinfo
- Info files
- Printed Books
- @-commands
- General Syntactic Conventions
- Comments
- What a Texinfo File Must Have
- Six Parts of a Texinfo File
- A Short Sample Texinfo File
- Acknowledgements
Using Texinfo Mode
- The Usual GNU Emacs Editing Commands
- Inserting Frequently Used Commands
- Showing the Section Structure of a File
- Updating Nodes and Menus
  - Updating Requirements
  - Other Updating Commands
- Formatting for Info
- Formatting and Printing
- Texinfo Mode Summary
Beginning a Texinfo File
- Sample Texinfo File Beginning
- The Texinfo File Header
- Summary and Copying Permissions for Info
- The Title and Copyright Pages
- The `Top' Node and Master Menu
  - Parts of a Master Menu
- Software Copying Permissions
Ending a Texinfo File
- Index Menus and Printing an Index
- Generating a Table of Contents
- @bye File Ending
Chapter Structuring
- Tree Structure of Sections
- Types of Structuring Command
- @top
- @chapter
- @unnumbered, @appendix
- @majorheading, @chapheading
- @section
- @unnumberedsec, @appendixsec, @heading
- The @subsection Command
- The @subsection-like Commands
- The `subsub' Commands
Nodes
- Node and Menu Illustration
- The @node Command
- Creating Pointers with makeinfo
Menus
- Writing a Menu
- The Parts of a Menu
- Less Cluttered Menu Entry
- A Menu Example
- Referring to Other Info Files
Cross References
- Different Cross Reference Commands
- Parts of a Cross Reference
- @xref
- Naming a `Top' Node
- @ref
- @pxref
- @inforef
Marking Words and Phrases
- Indicating Definitions, Commands, etc.
- Emphasizing Text
Quotations and Examples
- The Block Enclosing Commands
- @quotation
- @example
- @noindent
- @lisp
- @smallexample and @smalllisp
- @display
- @format
- @exdent: Undoing a Line's Indentation
- @flushleft and @flushright
- Drawing Cartouches Around Examples
Making Lists and Tables
- Making an Itemized List
- Making a Numbered or Lettered List
- Making a Two-column Table
  - @ftable and @vtable
  - @itemx
Creating Indices
- Making Index Entries
- Predefined Indices
- Defining the Entries of an Index
- Combining Indices
- Defining New Indices
Special Insertions
- Inserting `@', Braces, and Periods
- @dmn{dimension}: Format a Dimension
- Inserting Ellipsis, Dots, and Bullets
  - @dots{}
  - @bullet{}
- Inserting TeX and the Copyright Symbol
  - @TeX{}
  - @copyright{}
- @minus{}: Inserting a Minus Sign
Glyphs for Examples
- =>: Indicating Evaluation
- ==>: Indicating an Expansion
- -|: Indicating Printed Output
- error-->: Indicating an Error Message
- ==: Indicating Equivalence
- Indicating Point in a Buffer
Making and Preventing Breaks
- @*: Generate Line Breaks
- @w{text}: Prevent Line Breaks
- @sp n: Insert Blank Lines
- @page: Start a New Page
- @group: Prevent Page Breaks
- @need mils: Prevent Page Breaks
Definition Commands
- The Template for a Definition
- Optional and Repeated Arguments
- Two or More `First' Lines
- The Definition Commands
- Conventions for Writing Definitions
- A Sample Function Definition
Footnotes
Conditionally Visible Text
- Using Ordinary TeX Commands
- @set, @clear, and @value
Format and Print Hardcopy
- Format and Print Using Shell Commands
- From an Emacs Shell ...
- Formatting and Printing in Texinfo Mode
- Using the Local Variables List
- TeX Formatting Requirements Summary
- Preparing to Use TeX
- Overfull "hboxes"
- Printing "Small" Books
- Printing on A4 Paper
- Cropmarks and Magnification
Creating an Info File
- Running makeinfo from a Shell
- Options for makeinfo
- Pointer Validation
- Running makeinfo inside Emacs
- The texinfo-format... Commands
- Batch Formatting
- Tag Files and Split Files
Installing an Info File
- Listing a New Info File
- Info Files in Other Directories
@-Command List
Tips and Hints
A Sample Texinfo File
Sample Permissions
- `ifinfo' Copying Permissions
- Titlepage Copying Permissions
Include Files
- How to Use Include Files
- texinfo-multiple-files-update
- Include File Requirements
- Sample File with @include
- Evolution of Include Files
Page Headings
- Standard Heading Formats
- Specifying the Type of Heading
- How to Make Your Own Headings
Formatting Mistakes
- Catching Errors with Info Formatting
- Catching Errors with TeX Formatting
- Using texinfo-show-structure
- Using occur
- Finding Badly Referenced Nodes
Refilling Paragraphs
@-Command Syntax
How to Obtain TeX
Second Edition Features
- New Texinfo Mode Commands
- New Texinfo @-Commands
Command and Variable Index
Concept Index