Texinfo

The GNU Documentation Format

for Texinfo version 5.2, 26 September 2013

Robert J. Chassell
Richard M. Stallman

This manual is for GNU Texinfo (version 5.2, 26 September 2013), a documentation system that can produce both online information and a printed manual from a single source using semantic markup.

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, with the Front-Cover Texts being “A GNU Manual”, and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License”.

(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.”

Published by the Free Software Foundation
51 Franklin St, Fifth Floor
Boston, MA 02110-1301
USA
ISBN 1-882114-67-1

Cover art by Etienne Suvasa.

Texinfo

This manual is for GNU Texinfo (version 5.2, 26 September 2013), a documentation system that can produce both online information and a printed manual from a single source using semantic markup.

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.

— The Detailed Node Listing — Overview of Texinfo
Texinfo Copying Conditions		Your rights.
1 Overview of Texinfo		Texinfo in brief.
2 Using Texinfo Mode		Using the GNU Emacs 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		Creating chapters, sections, appendices, etc.
6 Nodes		Writing nodes, the basic unit of Texinfo.
7 Menus		Writing menus.
8 Cross References		Writing cross references.
9 Marking Text, Words and Phrases		Marking words and phrases as code, keyboard input, meta-syntactic variables, and the like.
10 Quotations and Examples		Block quotations, examples, etc.
11 Lists and Tables		Itemized or numbered lists, and tables.
12 Special Displays		Floating figures and footnotes.
13 Indices		Creating indices.
14 Special Insertions		Inserting @-signs, braces, etc.
15 Forcing and Preventing Breaks		Forcing or preventing line and page breaks.
16 Definition Commands		Describing functions and the like uniformly.
17 Internationalization		Supporting languages other than English.
18 Conditionally Visible Text		Specifying text for only some output cases.
19 Defining New Texinfo Commands		User-defined macros and aliases.
20 Include Files		How to incorporate other Texinfo files.
21 Formatting and Printing Hardcopy		Output for paper, with TeX.
22 `texi2any`: The Generic Translator for Texinfo		`texi2any`, an all-purpose converter.
23 Creating and Installing Info Files		Details on Info output.
24 Generating HTML		Details on HTML output.
Appendix A @-Command List		All the Texinfo @-commands.
Appendix B Tips and Hints		Hints on how to write a Texinfo document.
Appendix C Sample Texinfo Files		Complete examples, including full texts.
Appendix D Page Headings		How to write page headings and footings.
Appendix E Catching Mistakes		How to find mistakes in formatting.
Appendix F Info Format Specification		Technical details of the Info file format.
Appendix G GNU Free Documentation License		Copying this manual.
Command and Variable Index		A menu containing commands and variables.
General Index		A menu covering many topics.
1.1 Reporting Bugs		Submitting effective bug reports.
1.2 Using Texinfo		Create printed or online output.
1.3 Output Formats		Overview of the supported output formats.
1.4 Adding Output Formats		Man pages and implementing new formats.
1.5 Texinfo Document Structure		How Texinfo manuals are usually arranged.
1.6 Info Files		What is an Info file?
1.7 Printed Books		Characteristics of a printed book or manual.
1.8 @-commands		@-commands are used for formatting.
1.9 General Syntactic Conventions		General rules for writing a Texinfo file.
1.10 Comments		Writing comments and ignored text in general.
1.11 What a Texinfo File Must Have		What a Texinfo file must have.
1.12 Six Parts of a Texinfo File		Usually, a Texinfo file has six parts.
1.13 A Short Sample Texinfo File		A short sample Texinfo file.
1.14 History		Acknowledgements, contributors and genesis.
Using Texinfo Mode
2.1 Texinfo Mode Overview		How Texinfo mode can help you.
2.2 The Usual GNU Emacs Editing Commands		Texinfo mode adds to GNU Emacs’ general purpose editing features.
2.3 Inserting Frequently Used Commands		How to insert frequently used @-commands.
2.4 Showing the Sectioning Structure of a File		How to show the structure of a file.
2.5 Updating Nodes and Menus		How to update or create new nodes and menus.
2.6 Formatting for Info		How to format for Info.
2.7 Printing		How to format and print part or all of a file.
2.8 Texinfo Mode Summary		Summary of all the Texinfo mode commands.
Updating Nodes and Menus
2.5.1 The Updating Commands		Five major updating commands.
2.5.2 Updating Requirements		How to structure a Texinfo file for using the updating command.
2.5.3 Other Updating Commands		How to indent descriptions, insert missing nodes lines, and update nodes in sequence.
Beginning a Texinfo File
3.1 Sample Texinfo File Beginning		A sample beginning for a Texinfo file.
3.2 Texinfo File Header		The first lines.
3.3 Document Permissions		Ensuring your manual is free.
3.4 Title and Copyright Pages		Creating the title and copyright pages.
3.5 Generating a Table of Contents		How to create a table of contents.
3.6 The ‘Top’ Node and Master Menu		Creating the ‘Top’ node and master menu.
3.7 Global Document Commands		Affecting formatting throughout.
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`: Set the Output File Name		Tell Info the name of the Info file.
3.2.4 `@settitle`: Set the Document Title		Create a title for the printed work.
3.2.5 End of Header		Formatting a region requires this.
Document Permissions
3.3.1 `@copying`: Declare Copying Permissions		Declare the document’s copying permissions.
3.3.2 `@insertcopying`: Include Permissions Text		Where to insert the permissions.
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		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.
The ‘Top’ Node and Master Menu
3.6.1 Top Node Example
3.6.2 Parts of a Master Menu
Global Document Commands
3.7.1 `@documentdescription`: Summary Text		Document summary for the HTML output.
3.7.2 `@setchapternewpage`: Blank Pages Before Chapters		Start chapters on right-hand pages.
3.7.3 The `@headings` Command		An option for turning headings on and off and double or single sided printing.
3.7.4 `@paragraphindent`: Controlling Paragraph Indentation		Specify paragraph indentation.
3.7.5 `@firstparagraphindent`: Indenting After Headings		Suppressing first paragraph indentation.
3.7.6 `@exampleindent`: Environment Indenting		Specify environment indentation.
Ending a Texinfo File
4.1 Printing Indices and Menus		How to print an index in hardcopy and generate index menus in Info.
4.2 `@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 Structuring Command Types		How to divide a manual into parts.
5.3 `@chapter`: Chapter Structuring		Chapter structuring.
5.4 `@unnumbered`, `@appendix`: Chapters with Other Labeling
5.5 `@majorheading`, `@chapheading`: Chapter-level Headings
5.6 `@section`: Sections Below Chapters
5.7 `@unnumberedsec`, `@appendixsec`, `@heading`
5.8 `@subsection`: Subsections Below Sections
5.9 The `@subsection`-like Commands
5.10 `@subsection` and Other Subsub Commands		Commands for the lowest level sections.
5.11 `@part`: Groups of Chapters		Collections of chapters.
5.12 Raise/lower Sections: `@raisesections` and `@lowersections`		How to change commands’ hierarchical level.
Nodes
6.1 The `@node` Command		Creating nodes, in detail.
6.2 `makeinfo` Pointer Creation		Letting makeinfo determine node pointers.
6.3 `@anchor`: Defining Arbitrary Cross Reference Targets		Defining arbitrary cross reference targets.
6.4 Node and Menu Illustration		A diagram, and sample nodes and menus.
The `@node` Command
6.1.1 Choosing Node and Pointer Names		How to choose node and pointer names.
6.1.2 Writing an `@node` Line		How to write an `@node` line.
6.1.3 `@node` Line Requirements		Keep names unique.
6.1.4 The First Node		How to write a ‘Top’ node.
6.1.5 The `@top` Sectioning Command		How to use the `@top` command.
Menus
7.1 Menu Location		Menus go at the ends of nodes.
7.2 Writing a Menu		What is a menu?
7.3 The Parts of a Menu		A menu entry has three parts.
7.4 Less Cluttered Menu Entry		Two part menu entry.
7.5 A Menu Example		Two and three part menu entries.
7.6 Referring to Other Info Files		How to refer to a different Info file.
Cross References
8.1 What References Are For		What cross references are for.
8.2 Different Cross Reference Commands		A summary of the different commands.
8.3 Parts of a Cross Reference		A cross reference has several parts.
8.4 `@xref`		Begin a reference with ‘See’ …
8.5 Naming a ‘Top’ Node		How to refer to the beginning of another file.
8.6 `@ref`		A reference for the last part of a sentence.
8.7 `@pxref`		How to write a parenthetical cross reference.
8.8 `@inforef`: Cross References to Info-only Material		How to refer to an Info-only file.
8.9 `@url`, `@uref{url[, text][, replacement]}`		How to refer to a uniform resource locator.
8.10 `@cite`{`reference`}		How to refer to books not in the Info system.
`@xref`
8.4.1 What a Reference Looks Like and Requires		What a reference looks like and requires.
8.4.2 `@xref` with One Argument		`@xref` with one argument.
8.4.3 `@xref` with Two Arguments		`@xref` with two arguments.
8.4.4 `@xref` with Three Arguments		`@xref` with three arguments.
8.4.5 `@xref` with Four and Five Arguments		`@xref` with four and five arguments.
Marking Text, 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.
9.1.1 Highlighting Commands are Useful		Highlighting provides useful information.
9.1.2 `@code`{`sample-code`}		Indicating program code.
9.1.3 `@kbd`{`keyboard-characters`}		Showing keyboard input.
9.1.4 `@key`{`key-name`}		Specifying keys.
9.1.5 `@samp`{`text`}		Indicating a literal sequence of characters.
9.1.6 `@verb`{`chartextchar`}		Indicating a verbatim sequence of characters.
9.1.7 `@var`{`metasyntactic-variable`}		Indicating metasyntactic variables.
9.1.8 `@env`{`environment-variable`}		Indicating environment variables.
9.1.9 `@file`{`file-name`}		Indicating file names.
9.1.10 `@command`{`command-name`}		Indicating command names.
9.1.11 `@option`{`option-name`}		Indicating option names.
9.1.12 `@dfn`{`term`}		Specifying definitions.
9.1.13 `@abbr`{`abbreviation`[, `meaning`]}		Indicating abbreviations.
9.1.14 `@acronym`{`acronym`[, `meaning`]}		Indicating acronyms.
9.1.15 `@indicateurl`{`uniform-resource-locator`}		Indicating an example url.
9.1.16 `@email`{`email-address`[, `displayed-text`]}		Indicating 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		Various font commands for printed output.
Quotations and Examples
10.1 Block Enclosing Commands		Different constructs for different purposes.
10.2 `@quotation`: Block Quotations		Writing a quotation.
10.3 `@indentedblock`: Indented text blocks		Block of text indented on left.
10.4 `@example`: Example Text		Writing an example in a fixed-width font.
10.5 `@verbatim`: Literal Text		Writing a verbatim example.
10.6 `@verbatiminclude` `file`: Include a File Verbatim		Including a file verbatim.
10.7 `@lisp`: Marking a Lisp Example		Illustrating Lisp code.
10.8 `@small…` Block Commands		Examples in a smaller font.
10.9 `@display`: Examples Using the Text Font		Writing an example in the current font.
10.10 `@format`: Examples Using the Full Line Width		Writing an example without narrowed margins.
10.11 `@exdent`: Undoing a Line’s Indentation		Undo indentation on a line.
10.12 `@flushleft` and `@flushright`		Pushing text flush left or flush right.
10.13 `@raggedright`: Ragged Right Text		Avoiding justification on the right.
10.14 `@noindent`: Omitting Indentation		Preventing paragraph indentation.
10.15 `@indent`: Forcing Indentation		Forcing paragraph indentation.
10.16 `@cartouche`: Rounded Rectangles		Drawing rounded rectangles around text.
Lists and Tables
11.1 Introducing Lists		Texinfo formats lists for you.
11.2 `@itemize`: Making an Itemized List		How to construct a simple list.
11.3 `@enumerate`: Making a Numbered or Lettered List		How to construct a numbered list.
11.4 Making a Two-column Table		How to construct a two-column table.
11.5 `@multitable`: Multi-column Tables		How to construct generalized tables.
Making a Two-column Table
11.4.1 Using the `@table` Command		How to construct a two-column table.
11.4.2 `@ftable` and `@vtable`		Automatic indexing for two-column tables.
11.4.3 `@itemx`: Second and Subsequent Items		How to put more entries in the first column.
`@multitable`: Multi-column Tables
11.5.1 Multitable Column Widths		Defining multitable column widths.
11.5.2 Multitable Rows		Defining multitable rows, with examples.
Special Displays
12.1 Floats		Figures, tables, and the like.
12.2 Inserting Images		Including graphics and images.
12.3 Footnotes		Writing footnotes.
Floats
12.1.1 `@float` [`type`][,`label`]: Floating Material		Producing floating material.
12.1.2 `@caption` & `@shortcaption`		Specifying descriptions for floats.
12.1.3 `@listoffloats`: Tables of Contents for Floats		A table of contents for floats.
Inserting Images
12.2.1 Image Syntax
12.2.2 Image Scaling
Footnotes
12.3.1 Footnote Commands		How to write a footnote in Texinfo.
12.3.2 Footnote Styles		Controlling how footnotes appear in Info.
Indices
13.1 Making Index Entries		Choose different words for index entries.
13.2 Predefined Indices		Use different indices for different kinds of entries.
13.3 Defining the Entries of an Index		How to make an index entry.
13.4 Combining Indices		How to combine indices.
13.5 Defining New Indices		How to define your own indices.
Combining Indices
13.4.1 `@syncodeindex`: Combining indices using `@code`		How to merge two indices, using `@code` font for the merged-from index.
13.4.2 `@synindex`: Combining indices		How to merge two indices, using the roman font for the merged-from index.
Special Insertions
14.1 Special Characters: Inserting @ {} , \ #		Inserting @ {} , \ #
14.2 Inserting Quote Characters		Inserting left and right quotes, in code.
14.3 Inserting Space		Inserting the right amount of whitespace.
14.4 Inserting Accents		Inserting accents and special characters.
14.5 Inserting Quotation Marks		Inserting quotation marks.
14.6 `@math`: Inserting Mathematical Expressions		Formatting mathematical expressions.
14.7 Glyphs for Text		Inserting Dots, bullets, currencies, etc.
14.8 Glyphs for Programming		Indicating results of evaluation, expansion of macros, errors, etc.
Special Characters: Inserting @ {} , \ #
14.1.1 Inserting ‘@’ with `@@` and `@atchar{}`		`@@`, `@atchar{}`.
14.1.2 Inserting ‘{ ‘}’ with `@{ @}` and `@l rbracechar{}`		`@{ @}`, `@l rbracechar{}`.
14.1.3 Inserting ‘,’ with `@comma{}`		, and `@comma{}`.
14.1.4 Inserting ‘\’ with `@backslashchar{}`		\ and `@backslashchar{}`.
14.1.5 Inserting ‘#’ with `@hashchar{}`		# and `@hashchar{}`.
Inserting Space
14.3.1 Multiple Spaces		Inserting multiple spaces.
14.3.2 Not Ending a Sentence		Sometimes a . doesn’t end a sentence.
14.3.3 Ending a Sentence		Sometimes it does.
14.3.4 `@frenchspacing` `val`: Control Sentence Spacing		Specifying end-of-sentence spacing.
14.3.5 `@dmn`{`dimension`}: Format a Dimension		Formatting a dimension.
Glyphs for Text
14.7.1 `@TeX`{} (TeX) and `@LaTeX`{} (LaTeX)		The TeX logos.
14.7.2 `@copyright{}` (©)		The copyright symbol (c in a circle).
14.7.3 `@registeredsymbol{}` (®)		The registered symbol (R in a circle).
14.7.4 `@dots` (…) and `@enddots` (...)		How to insert ellipses: … and ...
14.7.5 `@bullet` (•)		How to insert a bullet: •
14.7.6 `@euro` (€): Euro Currency Symbol		How to insert the euro currency symbol.
14.7.7 `@pounds` (£): Pounds Sterling		How to insert the pounds currency symbol.
14.7.8 `@textdegree` (°): Degrees Symbol		How to insert the degrees symbol.
14.7.9 `@minus` (-): Inserting a Minus Sign		How to insert a minus sign.
14.7.10 `@geq` (≥) and `@leq` (≤): Inserting Relations		How to insert greater/less-than-or-equal signs.
Glyphs for Programming
14.8.1 Glyphs Summary
14.8.2 `@result{}` (⇒): Result of an Expression		How to show the result of expression.
14.8.3 `@expansion{}` (→): Indicating an Expansion		How to indicate an expansion.
14.8.4 `@print{}` (-\|): Indicating Generated Output		How to indicate generated output.
14.8.5 `@error{}` (error-->): Indicating an Error Message		How to indicate an error message.
14.8.6 `@equiv{}` (≡): Indicating Equivalence		How to indicate equivalence.
14.8.7 `@point{}` (∗): Indicating Point in a Buffer		How to indicate the location of point.
14.8.8 Click Sequences		Inserting GUI usage sequences.
Forcing and Preventing Breaks
15.1 Break Commands		Summary of break-related commands.
15.2 `@*` and `@/`: Generate and Allow Line Breaks		Forcing line breaks.
15.3 `@-` and `@hyphenation`: Helping TeX Hyphenate		Helping TeX with hyphenation points.
15.4 `@allowcodebreaks`: Control Line Breaks in `@code`		Controlling line breaks within @code text.
15.5 `@w`{`text`}: Prevent Line Breaks		Preventing unwanted line breaks in text.
15.6 `@tie{}`: Inserting an Unbreakable Space		Inserting an unbreakable but varying space.
15.7 `@sp` `n`: Insert Blank Lines		Inserting blank lines.
15.8 `@page`: Start a New Page		Forcing the start of a new page.
15.9 `@group`: Prevent Page Breaks		Preventing unwanted page breaks.
15.10 `@need mils`: Prevent Page Breaks		Another way to prevent unwanted page breaks.
Definition Commands
16.1 The Template for a Definition		Writing descriptions using definition commands.
16.2 Definition Command Continuation Lines		Continuing the heading over source lines.
16.3 Optional and Repeated Arguments		Handling optional and repeated arguments.
16.4 `@deffnx`, et al.: Two or More ‘First’ Lines		Group two or more ‘first’ lines.
16.5 The Definition Commands		Reference for all the definition commands.
16.6 Conventions for Writing Definitions		Conventions for writing definitions.
16.7 A Sample Function Definition		An example.
The Definition Commands
16.5.1 Functions and Similar Entities		Commands for functions and similar entities.
16.5.2 Variables and Similar Entities		Commands for variables and similar entities.
16.5.3 Functions in Typed Languages		Commands for functions in typed languages.
16.5.4 Variables in Typed Languages		Commands for variables in typed languages.
16.5.5 Data Types		The definition command for data types.
16.5.6 Object-Oriented Programming		Commands for object-oriented programming.
Object-Oriented Programming
16.5.6.1 Object-Oriented Variables
16.5.6.2 Object-Oriented Methods
Internationalization
17.1 `@documentlanguage ll[_cc]`: Set the Document Language		Declaring the current language.
17.2 `@documentencoding enc`: Set Input Encoding		Declaring the input encoding.
Conditionally Visible Text
18.1 Conditional Commands		Text for a given format.
18.2 Conditional Not Commands		Text for any format other than a given one.
18.3 Raw Formatter Commands		Using raw formatter commands.
18.4 Inline Conditionals: `@inline`, `@inlineifelse`, `@inlineraw`		Brace-delimited conditional text.
18.5 Flags: `@set`, `@clear`, conditionals, and `@value`		Variable tests and substitutions.
18.6 Testing for Texinfo Commands: `@ifcommanddefined`, `@ifcommandnotdefined`		Testing if a Texinfo command is available.
18.7 Conditional Nesting		Using conditionals inside conditionals.
`@set`, `@clear`, and `@value`
18.5.1 `@set` and `@value`		Expand a flag variable to a string.
18.5.2 `@ifset` and `@ifclear`		Format a region if a flag is set.
18.5.4 `@value` Example		An easy way to update edition information.
Defining New Texinfo Commands
19.1 Defining Macros		Defining and undefining new commands.
19.2 Invoking Macros		Using a macro, once you’ve defined it.
19.3 Macro Details and Caveats		Limitations of Texinfo macros.
19.4 ‘`@alias new=existing`’		Command aliases.
19.5 `@definfoenclose`: Customized Highlighting		Customized highlighting.
19.6 External Macro Processors: Line Directives		`#line` directives.
External Macro Processors: Line Directives
19.6.1 ‘`#line`’ Directive
19.6.2 ‘`#line`’ and TeX
19.6.3 ‘`#line`’ Syntax Details
Include Files
20.1 How to Use Include Files		How to use the `@include` command.
20.2 `texinfo-multiple-files-update`		How to create and update nodes and menus when using included files.
20.3 Include Files Requirements		`texinfo-multiple-files-update` needs.
20.4 Sample File with `@include`		A sample outer file with included files within it; and a sample included file.
20.5 Evolution of Include Files		How use of the `@include` command has changed over time.
Formatting and Printing Hardcopy
21.1 Use TeX		Use TeX to format for hardcopy.
21.2 Format with `tex`/`texindex`		How to format with explicit shell commands.
21.3 Format with `texi2dvi`		A simpler way to format.
21.4 Print With `lpr -d` From Shell		How to print.
21.5 From an Emacs Shell		How to format and print from an Emacs shell.
21.6 Formatting and Printing in Texinfo Mode		How to format and print in Texinfo mode.
21.7 Using the Local Variables List		How to print using Emacs’s compile command.
21.8 TeX Formatting Requirements Summary		TeX formatting requirements summary.
21.9 Preparing for TeX		What to do before you use TeX.
21.10 Overfull “hboxes”		What are and what to do with overfull hboxes.
21.11 `@smallbook`: Printing “Small” Books		How to print small format books and manuals.
21.12 Printing on A4 Paper		How to print on A4 or A5 paper.
21.13 `@pagesizes` [`width`][, `height`]: Custom Page Sizes		How to print with customized page sizes.
21.14 Cropmarks and Magnification		How to print marks to indicate the size of pages and how to print scaled up output.
21.15 PDF Output		Portable Document Format output.
21.16 Obtaining TeX		How to obtain TeX.
`texi2any`: The Generic Translator for Texinfo
22.1 `texi2any`: A Texinfo Reference Implementation		`texi2any`: the reference implementation.
22.2 Invoking `texi2any`/`makeinfo` from a Shell		Running the translator from a shell.
22.3 `texi2any` Printed Output		Calling `texi2dvi`.
22.4 Pointer Validation		How to check that pointers point somewhere.
22.5 Customization Variables		Configuring `texi2any`.
22.6 Internationalization of Document Strings		Translating program-inserted text.
22.7 Invoking `pod2texi`: Convert POD to Texinfo		Translating Perl pod to Texinfo.
22.8 `texi2html`: Ancestor of `texi2any`		An ancestor of `texi2any`.
Customization Variables
22.5.1 Customization Variables for @-Commands
22.5.2 Customization Variables and Options
22.5.4 Other Customization Variables
Creating and Installing Info Files
23.1 Creating an Info File
23.2 Installing an Info File
Creating an Info File
23.1.1 `makeinfo` Advantages		`makeinfo` provides better error checking.
23.1.2 Running `makeinfo` Within Emacs		How to run `makeinfo` from Emacs.
23.1.3 The `texinfo-format…` Commands		Two Info formatting commands written in Emacs Lisp are an alternative to `makeinfo`.
23.1.4 Batch Formatting		How to format for Info in Emacs Batch mode.
23.1.5 Tag Files and Split Files		How tagged and split files help Info to run better.
Installing an Info File
23.2.1 The Directory File ‘`dir`’		The top level menu for all Info files.
23.2.2 Listing a New Info File		Listing a new Info file.
23.2.3 Info Files in Other Directories		How to specify Info files that are located in other directories.
23.2.4 Installing Info Directory Files		How to specify what menu entry to add to the Info directory.
23.2.5 Invoking `install-info`		`install-info` options.
Generating HTML
24.1 HTML Translation		Details of the HTML output.
24.2 HTML Splitting		How HTML output is split.
24.3 HTML CSS		Influencing HTML output with Cascading Style Sheets.
24.4 HTML Cross References		Cross references in HTML output.
HTML Cross References
24.4.1 HTML Cross Reference Link Basics
24.4.2 HTML Cross Reference Node Name Expansion
24.4.3 HTML Cross Reference Command Expansion
24.4.4 HTML Cross Reference 8-bit Character Expansion
24.4.5 HTML Cross Reference Mismatch
24.4.6 HTML Cross Reference Configuration: ‘`htmlxref.cnf`’		htmlxref.cnf.
24.4.7 HTML Cross Reference Link Preservation: `manual`‘`-noderename.cnf`’		MANUAL-noderename.cnf.
@-Command List
A.1 @-Command Syntax		General syntax for varieties of @-commands.
A.2 @-Command Contexts		Guidelines for which commands can be used where.
Sample Texinfo Files
C.1 Short Sample
C.2 GNU Sample Texts
C.3 Verbatim Copying License
C.4 All-permissive Copying License
Page Headings
D.1 Headings Introduced		Conventions for using page headings.
D.2 Standard Heading Formats		Standard page heading formats.
D.3 Specifying the Type of Heading		How to specify the type of page heading.
D.4 How to Make Your Own Headings		How to create your own headings and footings.
Catching Mistakes
E.1 `makeinfo` Preferred		`makeinfo` finds errors.
E.2 Catching Errors with Info Formatting		How to catch errors with Info formatting.
E.3 Debugging with TeX		How to catch errors with TeX formatting.
E.4 Using `texinfo-show-structure`		How to use `texinfo-show-structure`.
E.5 Using `occur`		How to list all lines containing a pattern.
E.6 Finding Badly Referenced Nodes		How to find badly referenced nodes.
Finding Badly Referenced Nodes
E.6.1 Using `Info-validate`		How to run `Info-validate`.
E.6.2 Creating an Unsplit File		How to create an unsplit file.
E.6.3 Tagifying a File		How to tagify a file.
E.6.4 Splitting a File Manually		How to split a file manually.
Info Format Specification
F.1 Info Format General Layout
F.2 Info Format Text Constructs
Info Format General Layout
• Whole		Split vs. nonsplit manuals.
• Preamble
• Indirect
• Tag table
• Local variables
• Regular nodes
Info Format Text Constructs
F.2.1 Info Format: Menu
F.2.2 Info Format: Image
F.2.3 Info Format: Printindex
F.2.4 Info Format: Cross Reference

Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing. —Dick Brandon

This document was generated on October 2, 2013 using texi2html 5.0.