[Top] [Contents] [Index] [ ? ]

Texinfo

Texinfo is a documentation system that uses a single source file to produce both on-line information and printed output.

The first part of this master menu lists the major nodes in this Info document, including the @-command and concept indices. The rest of the menu lists all the lower level nodes in the document.

This is Edition 3.12 of the Texinfo documentation, 27 February 1998.

Texinfo Copying Conditions  Your rights.
1. Overview of Texinfo  Texinfo in brief.
2. Using Texinfo Mode  How to use Texinfo mode.
3. Beginning a Texinfo File  What is at the beginning of a Texinfo file?
4. Ending a Texinfo File  What is at the end of a Texinfo file?
5. Chapter Structuring  How to create chapters, sections, subsections, appendices, and other parts.
6. Nodes  How to write nodes.
7. Menus  How to write menus.
8. Cross References  How to write cross references.
9. Marking Words and Phrases  How to mark words and phrases as code, keyboard input, meta-syntactic variables, and the like.
10. Quotations and Examples  How to write quotations, examples, etc.
11. Lists and Tables  How to write lists and tables.
12. Creating Indices  How to create indices.
13. Special Insertions  How to insert @-signs, braces, etc.
14. Making and Preventing Breaks  How to force and prevent line and page breaks.
15. Definition Commands  How to describe functions and the like in a uniform manner.
16. Footnotes  How to write footnotes.
17. Conditionally Visible Text  How to specify text for either TeX or Info.
18. Macros: Defining New Texinfo Commands  Defining new Texinfo commands.
19. Format and Print Hardcopy  How to convert a Texinfo file to a file for printing and how to print that file.
20. Creating an Info File  Convert a Texinfo file into an Info file.
21. Installing an Info File  Make an Info file accessible to users.
A. @-Command List  All the Texinfo @-commands.
B. Tips and Hints  Hints on how to write a Texinfo document.
C. A Sample Texinfo File  A sample Texinfo file to look at.
D. Sample Permissions  Tell readers they have the right to copy and distribute.
E. Include Files  How to incorporate other Texinfo files.
F. Page Headings  How to write page headings and footings.
G. Formatting Mistakes  How to find formatting mistakes.
H. Refilling Paragraphs  All about paragraph refilling.
I. @-Command Syntax  A description of @-Command syntax.
J. How to Obtain TeX  
Command and Variable Index  A menu containing commands and variables.
Concept Index  A menu covering many topics.
-- The Detailed Node Listing ---
Overview of Texinfo
Using Texinfo  Create a conventional printed book or an Info file.
1.1 Info files  What is an Info file?
1.2 Printed Books  Characteristics of a printed book or manual.
1.3 @-commands  @-commands are used for formatting.
1.4 General Syntactic Conventions  General rules for writing a Texinfo file.
1.5 Comments  How to write comments and mark regions that the formatting commands will ignore.
1.6 What a Texinfo File Must Have  What a Texinfo file must have.
1.7 Six Parts of a Texinfo File  Usually, a Texinfo file has six parts.
1.8 A Short Sample Texinfo File  A short sample Texinfo file.
1.9 Acknowledgements  
Using Texinfo Mode
Texinfo Mode Overview  How Texinfo mode can help you.
2.1 The Usual GNU Emacs Editing Commands  Texinfo mode adds to GNU Emacs' general purpose editing features.
2.2 Inserting Frequently Used Commands  How to insert frequently used @-commands.
2.3 Showing the Section Structure of a File  How to show the structure of a file.
2.4 Updating Nodes and Menus  How to update or create new nodes and menus.
2.5 Formatting for Info  How to format for Info.
2.6 Formatting and Printing  How to format and print part or all of a file.
2.7 Texinfo Mode Summary  Summary of all the Texinfo mode commands.
Updating Nodes and Menus
The Updating Commands  Five major updating commands.
2.4.1 Updating Requirements  How to structure a Texinfo file for using the updating command.
2.4.2 Other Updating Commands  How to indent descriptions, insert missing nodes lines, and update nodes in sequence.
Beginning a Texinfo File
Four Parts Begin a File  Four parts begin a Texinfo file.
3.1 Sample Texinfo File Beginning  Here is a sample beginning for a Texinfo file.
3.2 The Texinfo File Header  The very beginning of a Texinfo file.
3.3 Summary and Copying Permissions for Info  Summary and copying permissions for Info.
3.4 The Title and Copyright Pages  Creating the title and copyright pages.
3.5 The `Top' Node and Master Menu  Creating the `Top' node and master menu.
3.6 Software Copying Permissions  Ensure that you and others continue to have the right to use and share software.
The Texinfo File Header
3.2.1 The First Line of a Texinfo File  The first line of a Texinfo file.
3.2.2 Start of Header  Formatting a region requires this.
3.2.3 @setfilename  Tell Info the name of the Info file.
3.2.4 @settitle  Create a title for the printed work.
3.2.5 @setchapternewpage  Start chapters on right-hand pages.
3.2.6 Paragraph Indenting  An option to specify paragraph indentation.
3.2.7 End of Header  Formatting a region requires this.
The Title and Copyright Pages
3.4.1 @titlepage  Create a title for the printed document.
3.4.2 @titlefont, @center, and @sp  The @titlefont, @center, and @sp commands.
3.4.3 @title, @subtitle, and @author  The @title, @subtitle, and @author commands.
3.4.4 Copyright Page and Permissions  How to write the copyright notice and include copying permissions.
3.4.5 Heading Generation  Turn on page headings after the title and copyright pages.
3.4.6 The @headings Command  An option for turning headings on and off and double or single sided printing.
The `Top' Node and Master Menu
`Top' Node Title  Sketch what the file is about.
3.5.1 Parts of a Master Menu  A master menu has three or more parts.
Ending a Texinfo File
4.1 Index Menus and Printing an Index  How to print an index in hardcopy and generate index menus in Info.
4.2 Generating a Table of Contents  How to create a table of contents.
4.3 @bye File Ending  How to mark the end of a file.
Chapter Structuring
5.1 Tree Structure of Sections  A manual is like an upside down tree ...
5.2 Types of Structuring Commands  How to divide a manual into parts.
5.3 @top  The @top command, part of the `Top' node.
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  Commands for the lowest level sections.
5.12 @raisesections and @lowersections  How to change commands' hierarchical level.
Nodes
Two Paths  Different commands to structure Info output and printed output.
6.1 Node and Menu Illustration  A diagram, and sample nodes and menus.
6.2 The @node Command  How to write a node, in detail.
6.3 Creating Pointers with makeinfo  How to create node pointers with makeinfo.
The @node Command
Choosing Node and Pointer Names  How to choose node and pointer names.
6.2.1 How to Write an @node Line  How to write an @node line.
6.2.2 @node Line Tips  Keep names short.
6.2.3 @node Line Requirements  Keep names unique, without @-commands.
6.2.4 The First Node  How to write a `Top' node.
6.2.5 The @top Sectioning Command  How to use the @top command.
6.2.6 The `Top' Node Summary  Write a brief description for readers.
Menus
Menus Need Short Nodes  Put a menu in a short node.
7.1 Writing a Menu  What is a menu?
7.2 The Parts of a Menu  A menu entry has three parts.
7.3 Less Cluttered Menu Entry  Two part menu entry.
7.4 A Menu Example  Two and three part menu entries.
7.5 Referring to Other Info Files  How to refer to a different Info file.
Cross References
What References Are For  What cross references are for.
8.1 Different Cross Reference Commands  A summary of the different commands.
8.2 Parts of a Cross Reference  A cross reference has several parts.
8.3 @xref  Begin a reference with `See' ...
8.4 Naming a `Top' Node  How to refer to the beginning of another file.
8.5 @ref  A reference for the last part of a sentence.
8.6 @pxref  How to write a parenthetical cross reference.
8.7 @inforef  How to refer to an Info-only file.
8.8 @uref{url[, displayed-text]}  How to refer to a uniform resource locator.
@xref
What a Reference Looks Like and Requires  What a reference looks like and requires.
8.3.1 @xref with One Argument  @xref with one argument.
8.3.2 @xref with Two Arguments  @xref with two arguments.
8.3.3 @xref with Three Arguments  @xref with three arguments.
8.3.4 @xref with Four and Five Arguments  @xref with four and five arguments.
Marking Words and Phrases
9.1 Indicating Definitions, Commands, etc.  How to indicate definitions, files, etc.
9.2 Emphasizing Text  How to emphasize text.
Indicating Definitions, Commands, etc.
Highlighting Commands are Useful  Highlighting provides useful information.
9.1.1 @code{sample-code}  How to indicate code.
9.1.2 @kbd{keyboard-characters}  How to show keyboard input.
9.1.3 @key{key-name}  How to specify keys.
9.1.4 @samp{text}  How to show a literal sequence of characters.
9.1.5 @var{metasyntactic-variable}  How to indicate a metasyntactic variable.
9.1.6 @file{file-name}  How to indicate the name of a file.
9.1.7 @dfn{term}  How to specify a definition.
9.1.8 @cite{reference}  How to refer to a book that is not in Info.
9.1.9 @url{uniform-resource-locator}  How to indicate a world wide web reference.
9.1.10 @email{email-address[, displayed-text]}  How to indicate an electronic mail address.
Emphasizing Text
9.2.1 @emph{text} and @strong{text}  How to emphasize text in Texinfo.
9.2.2 @sc{text}: The Small Caps Font  How to use the small caps font.
9.2.3 Fonts for Printing, Not Info  Various font commands for printed output.
9.2.4 Customized Highlighting  How to define highlighting commands.
Quotations and Examples
10.1 The Block Enclosing Commands  Use different constructs for different purposes.
10.2 @quotation  How to write a quotation.
10.3 @example  How to write an example in a fixed-width font.
10.4 @noindent  How to prevent paragraph indentation.
10.5 @lisp  How to illustrate Lisp code.
10.6 @smallexample and @smalllisp  Forms for the @smallbook option.
10.7 @display  How to write an example in the current font.
10.8 @format  How to write an example that does not narrow the margins.
10.9 @exdent: Undoing a Line's Indentation  How to undo the indentation of a line.
10.10 @flushleft and @flushright  How to push text flushleft or flushright.
10.11 Drawing Cartouches Around Examples  How to draw cartouches around examples.
Lists and Tables
Introducing Lists  Texinfo formats lists for you.
11.1 Making an Itemized List  How to construct a simple list.
11.2 Making a Numbered or Lettered List  How to construct a numbered list.
11.3 Making a Two-column Table  How to construct a two-column table.
11.4 Multi-column Tables  How to construct generalized tables.
Making a Two-column Table
Using the @table Command  How to construct a two-column table.
11.3.1 @ftable and @vtable  Automatic indexing for two-column tables.
11.3.2 @itemx  How to put more entries in the first column.
Multi-column Tables
11.4.1 Multitable Column Widths  Defining multitable column widths.
11.4.2 Multitable Rows  Defining multitable rows, with examples.
Creating Indices
12.1 Making Index Entries  Choose different words for index entries.
12.2 Predefined Indices  Use different indices for different kinds of entry.
12.3 Defining the Entries of an Index  How to make an index entry.
12.4 Combining Indices  How to combine indices.
12.5 Defining New Indices  How to define your own indices.
Combining Indices
12.4.1 @syncodeindex  How to merge two indices, using @code font for the merged-from index.
12.4.2 @synindex  How to merge two indices, using the default font of the merged-to index.
Special Insertions
13.1 Inserting @ and Braces  How to insert braces, `@'.
13.2 Inserting Space  How to insert the right amount of space within a sentence.
13.3 Inserting Accents  How to insert accents and special characters.
13.4 Inserting Ellipsis, Dots, and Bullets  How to insert dots and bullets.
13.5 Inserting TeX and the Copyright Symbol  How to insert the TeX logo and the copyright symbol.
13.6 @pounds{} (£): Pounds Sterling  How to insert the pounds currency symbol.
13.7 @minus{} (-): Inserting a Minus Sign  How to insert a minus sign.
13.8 @math - Inserting Mathematical Expressions  How to format a mathematical expression.
13.9 Glyphs for Examples  How to indicate results of evaluation, expansion of macros, errors, etc.
13.10 Inserting Images  How to include graphics.
Inserting @ and Braces
13.1.1 Inserting `@' with @@  How to insert `@'.
13.1.2 Inserting `{' and `}'with @{ and @}  How to insert `{' and `}'.
Inserting Space
13.2.1 Not Ending a Sentence  Sometimes a . doesn't end a sentence.
13.2.2 Ending a Sentence  Sometimes it does.
13.2.3 Multiple Spaces  Inserting multiple spaces.
13.2.4 @dmn{dimension}: Format a Dimension  How to format a dimension.
Inserting Ellipsis, Dots, and Bullets
13.4.1 @dots{} (...)  How to insert dots ...
13.4.2 @bullet{} (*)  How to insert a bullet.
Inserting TeX and the Copyright Symbol
13.5.1 @TeX{} (TeX)  How to insert the TeX logo.
13.5.2 @copyright{} (©)  How to use @copyright{}.
Glyphs for Examples
Glyphs Summary  
13.9.1 @result{} (=>): Indicating Evaluation  How to show the result of expression.
13.9.2 @expansion{} (==>): Indicating an Expansion  How to indicate an expansion.
13.9.3 @print{} (-|): Indicating Printed Output  How to indicate printed output.
13.9.4 @error{} (error-->): Indicating an Error Message  How to indicate an error message.
13.9.5 @equiv{} (==): Indicating Equivalence  How to indicate equivalence.
13.9.6 @point{} (-!-): Indicating Point in a Buffer  How to indicate the location of point.
Glyphs Summary
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  
Making and Preventing Breaks
The Break Commands  Cause and prevent splits.
14.1 @*: Generate Line Breaks  How to force a single line to use two lines.
14.2 @- and @hyphenation: Helping TeX hyphenate  How to tell TeX about hyphenation points.
14.3 @w{text}: Prevent Line Breaks  How to prevent unwanted line breaks.
14.4 @sp n: Insert Blank Lines  How to insert blank lines.
14.5 @page: Start a New Page  How to force the start of a new page.
14.6 @group: Prevent Page Breaks  How to prevent unwanted page breaks.
14.7 @need mils: Prevent Page Breaks  Another way to prevent unwanted page breaks.
Definition Commands
15.1 The Template for a Definition  How to structure a description using a definition command.
15.2 Optional and Repeated Arguments  How to handle optional and repeated arguments.
15.3 Two or More `First' Lines  How to group two or more `first' lines.
15.4 The Definition Commands  All the definition commands.
15.5 Conventions for Writing Definitions  Conventions for writing definitions.
15.6 A Sample Function Definition  
The Definition Commands
15.4.1 Functions and Similar Entities  Commands for functions and similar entities.
15.4.2 Variables and Similar Entities  Commands for variables and similar entities.
15.4.3 Functions in Typed Languages  Commands for functions in typed languages.
15.4.4 Variables in Typed Languages  Commands for variables in typed languages.
15.4.5 Object-Oriented Programming  Commands for object-oriented programming.
15.4.6 Data Types  The definition command for data types.
Footnotes
16.1 Footnote Commands  How to write a footnote in Texinfo.
16.2 Footnote Styles  Controlling how footnotes appear in Info.
Conditionally Visible Text
Conditional Commands  Specifying text for HTML, Info, or TeX.
17.1 Conditional Not Commands  Specifying text for not HTML, Info, or TeX.
17.2 Raw Formatter Commands  Using raw TeX or HTML commands.
17.3 @set, @clear, and @value  Designating which text to format (for all output formats); and how to set a flag to a string that you can insert.
@set, @clear, and @value
17.3.1 @ifset and @ifclear  Format a region if a flag is set.
17.3.2 @value  Replace a flag with a string.
17.3.3 @value Example  An easy way to update edition information.
Macros: Defining New Texinfo Commands
18.1 Defining Macros  Both defining and undefining new commands.
18.2 Invoking Macros  Using a macro, once you've defined it.
Format and Print Hardcopy
Use TeX  Use TeX to format for hardcopy.
19.1 Format using tex and texindex  How to format in a shell.
19.2 Format using texi2dvi  A simpler way to use the shell.
19.3 Shell Print Using lpr -d  How to print.
19.4 From an Emacs Shell  How to format and print from an Emacs shell.
19.5 Formatting and Printing in Texinfo Mode  How to format and print in Texinfo mode.
19.6 Using the Local Variables List  How to print using Emacs's compile command.
19.7 TeX Formatting Requirements Summary  TeX formatting requirements summary.
19.8 Preparing to Use TeX  What you need to do to use TeX.
19.9 Overfull "hboxes"  What are and what to do with overfull hboxes.
19.10 Printing "Small" Books  How to print small format books and manuals.
19.11 Printing on A4 Paper  How to print on European A4 paper.
19.12 Cropmarks and Magnification  How to print marks to indicate the size of pages and how to print scaled up output.
Creating an Info File
makeinfo Preferred  makeinfo provides better error checking.
20.1 Running makeinfo from a Shell  How to run makeinfo from a shell.
20.2 Options for makeinfo  Specify fill-column and other options.
20.3 Pointer Validation  How to check that pointers point somewhere.
20.4 Running makeinfo inside Emacs  How to run makeinfo from Emacs.
20.5 The texinfo-format... Commands  Two Info formatting commands written in Emacs Lisp are an alternative to makeinfo.
20.6 Batch Formatting  How to format for Info in Emacs Batch mode.
20.7 Tag Files and Split Files  How tagged and split files help Info to run better.
Installing an Info File
The `dir' File  The top level menu for all Info files.
21.1 Listing a New Info File  Listing a new info file.
21.2 Info Files in Other Directories  How to specify Info files that are located in other directories.
21.3 Installing Info Directory Files  How to specify what menu entry to add to the Info directory.
21.4 Invoking install-info  install-info options.
Sample Permissions
D.1 Inserting Permissions  How to put permissions in your document.
D.2 `ifinfo' Copying Permissions  Sample `ifinfo' copying permissions.
D.3 Titlepage Copying Permissions  Sample Titlepage copying permissions.
Include Files
E.1 How to Use Include Files  How to use the @include command.
E.2 texinfo-multiple-files-update  How to create and update nodes and menus when using included files.
E.3 Include File Requirements  What texinfo-multiple-files-update expects.
E.4 Sample File with @include  A sample outer file with included files within it; and a sample included file.
E.5 Evolution of Include Files  How use of the @include command has changed over time.
Page Headings
Headings Introduced  Conventions for using page headings.
F.1 Standard Heading Formats  Standard page heading formats.
F.2 Specifying the Type of Heading  How to specify the type of page heading.
F.3 How to Make Your Own Headings  How to create your own headings and footings.
Formatting Mistakes
makeinfo Find Errors  makeinfo finds errors.
G.1 Catching Errors with Info Formatting  How to catch errors with Info formatting.
G.2 Catching Errors with TeX Formatting  How to catch errors with TeX formatting.
G.3 Using texinfo-show-structure  How to use texinfo-show-structure.
G.4 Using occur  How to list all lines containing a pattern.
G.5 Finding Badly Referenced Nodes  How to find badly referenced nodes.
Finding Badly Referenced Nodes
G.5.1 Running Info-validate  How to run Info-validate.
G.5.2 Creating an Unsplit File  How to create an unsplit file.
G.5.3 Tagifying a File  How to tagify a file.
G.5.4 Splitting a File Manually  How to split a file manually.
How to Obtain TeX


This document was generated by XEmacs Webmaster on July, 12 2002 using texi2html