Table of Contents

Texinfo Copying Conditions
1. Overview of Texinfo

1.1 Info files
1.2 Printed Books
1.3 @-commands
1.4 General Syntactic Conventions
1.5 Comments
1.6 What a Texinfo File Must Have
1.7 Six Parts of a Texinfo File
1.8 A Short Sample Texinfo File
1.9 Acknowledgements

2. Using Texinfo Mode

2.1 The Usual GNU Emacs Editing Commands
2.2 Inserting Frequently Used Commands
2.3 Showing the Section Structure of a File
2.4 Updating Nodes and Menus

2.4.1 Updating Requirements
2.4.2 Other Updating Commands

2.5 Formatting for Info
2.6 Formatting and Printing
2.7 Texinfo Mode Summary

3. Beginning a Texinfo File

3.1 Sample Texinfo File Beginning
3.2 The Texinfo File Header

3.2.1 The First Line of a Texinfo File
3.2.2 Start of Header
3.2.3 @setfilename
3.2.4 @settitle
3.2.5 @setchapternewpage
3.2.6 Paragraph Indenting
3.2.7 End of Header

3.3 Summary and Copying Permissions for Info
3.4 The Title and Copyright Pages

3.4.1 @titlepage
3.4.2 @titlefont, @center, and @sp
3.4.3 @title, @subtitle, and @author
3.4.4 Copyright Page and Permissions
3.4.5 Heading Generation
3.4.6 The @headings Command

3.5 The `Top' Node and Master Menu

3.5.1 Parts of a Master Menu

3.6 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 Types of Structuring Commands
5.3 @top
5.4 @chapter
5.5 @unnumbered, @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 Node and Menu Illustration
6.2 The @node Command

6.2.1 How to Write an @node Line
6.2.2 @node Line Tips
6.2.3 @node Line Requirements
6.2.4 The First Node
6.2.5 The @top Sectioning Command
6.2.6 The `Top' Node Summary

6.3 Creating Pointers with makeinfo

7. Menus

7.1 Writing a Menu
7.2 The Parts of a Menu
7.3 Less Cluttered Menu Entry
7.4 A Menu Example
7.5 Referring to Other Info Files

8. Cross References

8.1 Different Cross Reference Commands
8.2 Parts of a Cross Reference
8.3 @xref

8.3.1 @xref with One Argument
8.3.2 @xref with Two Arguments
8.3.3 @xref with Three Arguments
8.3.4 @xref with Four and Five Arguments

8.4 Naming a `Top' Node
8.5 @ref
8.6 @pxref
8.7 @inforef
8.8 @uref{url[, displayed-text]}

9. Marking Words and Phrases

9.1 Indicating Definitions, Commands, etc.

9.1.1 @code{sample-code}
9.1.2 @kbd{keyboard-characters}
9.1.3 @key{key-name}
9.1.4 @samp{text}
9.1.5 @var{metasyntactic-variable}
9.1.6 @file{file-name}
9.1.7 @dfn{term}
9.1.8 @cite{reference}
9.1.9 @url{uniform-resource-locator}
9.1.10 @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
9.2.4 Customized Highlighting

10. Quotations and Examples

10.1 The Block Enclosing Commands
10.2 @quotation
10.3 @example
10.4 @noindent
10.5 @lisp
10.6 @smallexample and @smalllisp
10.7 @display
10.8 @format
10.9 @exdent: Undoing a Line's Indentation
10.10 @flushleft and @flushright
10.11 Drawing Cartouches Around Examples

11. Lists and Tables

11.1 Making an Itemized List
11.2 Making a Numbered or Lettered List
11.3 Making a Two-column Table

11.3.1 @ftable and @vtable
11.3.2 @itemx

11.4 Multi-column Tables

11.4.1 Multitable Column Widths
11.4.2 Multitable Rows

12. Creating 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, Dots, and Bullets

13.4.1 @dots{} (...)
13.4.2 @bullet{} (*)

13.5 Inserting TeX and the Copyright Symbol

13.5.1 @TeX{} (TeX)
13.5.2 @copyright{} (©)

13.6 @pounds{} (£): Pounds Sterling
13.7 @minus{} (-): Inserting a Minus Sign
13.8 @math - Inserting Mathematical Expressions
13.9 Glyphs for Examples

13.9.1 @result{} (=>): Indicating Evaluation
13.9.2 @expansion{} (==>): Indicating an Expansion
13.9.3 @print{} (-|): Indicating Printed Output
13.9.4 @error{} (error-->): Indicating an Error Message
13.9.5 @equiv{} (==): Indicating Equivalence
13.9.6 @point{} (-!-): Indicating Point in a Buffer

13.10 Inserting Images

14. Making and Preventing Breaks

14.1 @*: Generate Line Breaks
14.2 @- and @hyphenation: Helping TeX hyphenate
14.3 @w{text}: Prevent Line Breaks
14.4 @sp n: Insert Blank Lines
14.5 @page: Start a New Page
14.6 @group: Prevent Page Breaks
14.7 @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. Footnotes

16.1 Footnote Commands
16.2 Footnote Styles

17. Conditionally Visible Text

17.1 Conditional Not Commands
17.2 Raw Formatter Commands
17.3 @set, @clear, and @value

17.3.1 @ifset and @ifclear
17.3.2 @value
17.3.3 @value Example

18. Macros: Defining New Texinfo Commands

18.1 Defining Macros
18.2 Invoking Macros

19. Format and Print Hardcopy

19.1 Format using tex and texindex
19.2 Format using texi2dvi
19.3 Shell Print Using lpr -d
19.4 From an Emacs Shell
19.5 Formatting and Printing in Texinfo Mode
19.6 Using the Local Variables List
19.7 TeX Formatting Requirements Summary
19.8 Preparing to Use TeX
19.9 Overfull "hboxes"
19.10 Printing "Small" Books
19.11 Printing on A4 Paper
19.12 Cropmarks and Magnification

20. Creating an Info File

20.1 Running makeinfo from a Shell
20.2 Options for makeinfo
20.3 Pointer Validation
20.4 Running makeinfo inside Emacs
20.5 The texinfo-format... Commands
20.6 Batch Formatting
20.7 Tag Files and Split Files

21. Installing an Info File

21.1 Listing a New Info File
21.2 Info Files in Other Directories
21.3 Installing Info Directory Files
21.4 Invoking install-info

A. @-Command List
B. Tips and Hints
C. A Sample Texinfo File
D. Sample Permissions

D.1 Inserting Permissions
D.2 `ifinfo' Copying Permissions
D.3 Titlepage Copying Permissions

E. Include Files

E.1 How to Use Include Files
E.2 texinfo-multiple-files-update
E.3 Include File Requirements
E.4 Sample File with @include
E.5 Evolution of Include Files

F. Page Headings

F.1 Standard Heading Formats
F.2 Specifying the Type of Heading
F.3 How to Make Your Own Headings

G. Formatting Mistakes

G.1 Catching Errors with Info Formatting
G.2 Catching Errors with TeX Formatting
G.3 Using texinfo-show-structure
G.4 Using occur
G.5 Finding Badly Referenced Nodes

G.5.1 Running Info-validate
G.5.2 Creating an Unsplit File
G.5.3 Tagifying a File
G.5.4 Splitting a File Manually

H. Refilling Paragraphs
I. @-Command Syntax
J. How to Obtain TeX
Command and Variable Index
Concept Index