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

Texinfo

This manual is for GNU Texinfo (version 4.13, 18 September 2008), a documentation system that can produce both online information and a printed manual from a single source.

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.

Texinfo Copying Conditions   Your rights.
1. Overview of Texinfo   Texinfo in brief.
2. Using Texinfo Mode   Using the XEmacs 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 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. Conditionally Visible Text   Specifying text for only some output cases.
18. Internationalization   Supporting languages other than English.
19. Defining New Texinfo Commands   User-defined macros and aliases.
20. Formatting and Printing Hardcopy   Output for paper, with TeX.
21. Creating and Installing Info Files   Details on Info output.
22. Generating HTML   Details on HTML output.
A. @-Command List   All the Texinfo @-commands.
B. Tips and Hints   Hints on how to write a Texinfo document.
C. Sample Texinfo Files   Complete examples, including full texts.
D. Include Files   How to incorporate other Texinfo files.
E. Page Headings   How to write page headings and footings.
F. Formatting Mistakes   How to find formatting mistakes.
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. 
 — The Detailed Node Listing —

Overview of Texinfo
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 Info Files   What is an Info file?
1.5 Printed Books   Characteristics of a printed book or manual.
1.6 @-commands   @-commands are used for formatting.
1.7 General Syntactic Conventions   General rules for writing a Texinfo file.
1.8 Comments   Writing comments and ignored text in general.
1.9 What a Texinfo File Must Have   What a Texinfo file must have.
1.10 Six Parts of a Texinfo File   Usually, a Texinfo file has six parts.
1.11 A Short Sample Texinfo File   A short sample Texinfo file.
1.12 History   Acknowledgements, contributors and genesis. 
Using Texinfo Mode
2.1 Texinfo Mode Overview   How Texinfo mode can help you.
2.2 The Usual XEmacs Editing Commands   Texinfo mode adds to XEmacs’ general purpose editing features.
2.3 Inserting Frequently Used Commands   How to insert frequently used @-commands.
2.4 Showing the Section 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.
3.8 Software Copying Permissions   Ensure that you and others continue to have the right to use and share software. 
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.
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
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:   Start chapters on right-hand pages.
3.7.3 @paragraphindent: Paragraph Indenting   Specify paragraph indentation.
3.7.4 @firstparagraphindent: Indenting After Headings   Suppress indentation of the first paragraph.
3.7.5 @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 @top   The @top command, part of the ‘Top’ node.
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   Commands for the lowest level sections.
5.12 @raisesections and @lowersections   How to change commands’ hierarchical level. 
Nodes
6.1 Two Paths   Different commands to structure Info output and printed output.
6.2 Node and Menu Illustration   A diagram, and sample nodes and menus.
6.3 The @node Command   Creating nodes, in detail.
6.4 Creating Pointers with makeinfo   Letting makeinfo determine node pointers.
6.5 @anchor: Defining Arbitrary Cross-reference Targets   Defining arbitrary cross-reference targets. 
The @node Command
6.3.1 Choosing Node and Pointer Names   How to choose node and pointer names.
6.3.2 How to Write an @node Line   How to write an @node line.
6.3.3 @node Line Tips   Keep names short.
6.3.4 @node Line Requirements   Keep names unique, without @-commands.
6.3.5 The First Node   How to write a ‘Top’ node.
6.3.6 The @top Sectioning Command   How to use the @top command. 
Menus
7.1 Menu Location   Menus go at the ends of short 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   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 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}   A literal sequence of characters.
9.1.6 @verb{<char>text<char>}   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 a World Wide Web reference.
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, Not Info   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 @example: Example Text   Writing an example in a fixed-width font.
10.4 @verbatim: Literal Text   Writing a verbatim example.
10.5 @verbatiminclude file: Include a File Verbatim   Including a file verbatim.
10.6 @lisp: Marking a Lisp Example   Illustrating Lisp code.
10.7 @small… Block Commands   Examples in a smaller font.
10.8 @display and @smalldisplay   Writing an example in the current font.
10.9 @format and @smallformat   Writing an example without narrowed margins.
10.10 @exdent: Undoing a Line’s Indentation   Undo indentation on a line.
10.11 @flushleft and @flushright   Pushing text flush left or flush right.
10.12 @noindent: Omitting Indentation   Preventing paragraph indentation.
10.13 @indent: Forcing Indentation   Forcing paragraph indentation.
10.14 @cartouche: Rounded Rectangles Around Examples   Drawing rounded rectangles around examples. 
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   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   How to merge two indices, using @code font for the merged-from index.
13.4.2 @synindex   How to merge two indices, using the default font of the merged-to index. 
Special Insertions
14.1 Inserting @ and {} and ,  
14.2 Inserting Quote Characters   Inserting left and right quotes, in code.
14.3 Inserting Space   How to insert the right amount of space within a sentence.
14.4 Inserting Accents   How to insert accents and special characters.
14.5 Inserting Quotation Marks   How to insert quotation marks.
14.6 Inserting Ellipsis and Bullets   How to insert dots and bullets.
14.7 Inserting TeX and Legal Symbols: ©, ®   How to insert the TeX logo and the copyright symbol.
14.8 @euro{} (€): Euro Currency Symbol   How to insert the Euro currency symbol.
14.9 @pounds{} (£): Pounds Sterling   How to insert the pounds currency symbol.
14.10 @textdegree{} (°): Degrees Symbol   How to insert the degrees symbol.
14.11 @minus{} (-): Inserting a Minus Sign   How to insert a minus sign.
14.12 @geq{} (≥) and @leq{} (≤): Inserting relations   How to insert greater/less-than-or-equal signs.
14.13 @math: Inserting Mathematical Expressions   How to format a mathematical expression.
14.14 Click Sequences   Inserting GUI usage sequences.
14.15 Glyphs for Examples   How to indicate results of evaluation, expansion of macros, errors, etc. 
Inserting @ and {} and ,
14.1.1 Inserting ‘@’ with @@  
14.1.2 Inserting ‘{’ and ‘}’ with @{ and @}  
14.1.3 Inserting ‘,’ with @comma{}   
Inserting Space
14.3.1 Not Ending a Sentence   Sometimes a . doesn’t end a sentence.
14.3.2 Ending a Sentence   Sometimes it does.
14.3.3 Multiple Spaces   Inserting multiple spaces.
14.3.4 @frenchspacing val: Control sentence spacing   Specifying end-of-sentence spacing.
14.3.5 @dmn{dimension}: Format a Dimension   How to format a dimension. 
Inserting Ellipsis and Bullets
14.6.1 @dots{} (…) and @enddots{} (...)   How to insert dots …
14.6.2 @bullet{} (•)   How to insert a bullet. 
Inserting TeX and Legal Symbols: ©, ®
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). 
Glyphs for Examples
14.15.1 Glyphs Summary  
14.15.2 @result{} (⇒): Indicating Evaluation   How to show the result of expression.
14.15.3 @expansion{} (→): Indicating an Expansion   How to indicate an expansion.
14.15.4 @print{} (-|): Indicating Printed Output   How to indicate printed output.
14.15.5 @error{} (error-->): Indicating an Error Message   How to indicate an error message.
14.15.6 @equiv{} (≡): Indicating Equivalence   How to indicate equivalence.
14.15.7 @point{} (∗): Indicating Point in a Buffer   How to indicate the location of point. 
Glyphs Summary
14.15.2 @result{} (⇒): Indicating Evaluation  
14.15.3 @expansion{} (→): Indicating an Expansion  
14.15.4 @print{} (-|): Indicating Printed Output  
14.15.5 @error{} (error-->): Indicating an Error Message  
14.15.6 @equiv{} (≡): Indicating Equivalence  
14.15.7 @point{} (∗): Indicating Point in a Buffer   
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 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   
Conditionally Visible Text
17.1 Conditional Commands   Text for a given format.
17.2 Conditional Not Commands   Text for any format other than a given one.
17.3 Raw Formatter Commands   Using raw formatter commands.
17.4 @set, @clear, and @value   Variable tests and substitutions.
17.5 Conditional Nesting   Using conditionals inside conditionals. 
@set, @clear, and @value
17.4.1 @set and @value   Expand a flag variable to a string.
17.4.2 @ifset and @ifclear   Format a region if a flag is set.
17.4.3 @value Example   An easy way to update edition information. 
Internationalization
18.1 @documentlanguage ll[_cc]: Set the Document Language   Declaring the current language.
18.2 @documentencoding enc: Set Input Encoding   Declaring the input encoding. 
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. 
Formatting and Printing Hardcopy
20.1 Use TeX   Use TeX to format for hardcopy.
20.2 Format with tex and texindex   How to format with explicit shell commands.
20.3 Format with texi2dvi   A simpler way to format.
20.4 Shell Print Using lpr -d   How to print.
20.5 From an XEmacs Shell   How to format and print from an XEmacs shell.
20.6 Formatting and Printing in Texinfo Mode   How to format and print in Texinfo mode.
20.7 Using the Local Variables List   How to print using XEmacs’s compile command.
20.8 TeX Formatting Requirements Summary   TeX formatting requirements summary.
20.9 Preparing for TeX   What to do before you use TeX.
20.10 Overfull “hboxes”   What are and what to do with overfull hboxes.
20.11 Printing “Small” Books   How to print small format books and manuals.
20.12 Printing on A4 Paper   How to print on A4 or A5 paper.
20.13 @pagesizes [width][, height]: Custom Page Sizes   How to print with customized page sizes.
20.14 Cropmarks and Magnification   How to print marks to indicate the size of pages and how to print scaled up output.
20.15 PDF Output   Portable Document Format output.
20.16 How to Obtain TeX  
Creating and Installing Info Files
21.1 Creating an Info File  
21.2 Installing an Info File   
Creating an Info File
21.1.1 makeinfo Preferred   makeinfo provides better error checking.
21.1.2 Running makeinfo from a Shell   How to run makeinfo from a shell.
21.1.3 Options for makeinfo   Specify fill-column and other options.
21.1.4 Pointer Validation   How to check that pointers point somewhere.
21.1.5 Running makeinfo Within XEmacs   How to run makeinfo from XEmacs.
21.1.6 The texinfo-format… Commands   Two Info formatting commands written in XEmacs Lisp are an alternative to makeinfo.
21.1.7 Batch Formatting   How to format for Info in XEmacs Batch mode.
21.1.8 Tag Files and Split Files   How tagged and split files help Info to run better. 
Installing an Info File
21.2.1 The Directory File ‘dir’   The top level menu for all Info files.
21.2.2 Listing a New Info File   Listing a new Info file.
21.2.3 Info Files in Other Directories   How to specify Info files that are located in other directories.
21.2.4 Installing Info Directory Files   How to specify what menu entry to add to the Info directory.
21.2.5 Invoking install-info   install-info options. 
Generating HTML
22.1 HTML Translation   Details of the HTML output.
22.2 HTML Splitting   How HTML output is split.
22.3 HTML CSS   Influencing HTML output with Cascading Style Sheets.
22.4 HTML Cross-references   Cross-references in HTML output. 
HTML Cross-references
22.4.1 HTML Cross-reference Link Basics  
22.4.2 HTML Cross-reference Node Name Expansion  
22.4.3 HTML Cross-reference Command Expansion  
22.4.4 HTML Cross-reference 8-bit Character Expansion  
22.4.5 HTML Cross-reference Mismatch   
@-Command List
A.1 @-Command Syntax   General syntax for varieties of @-commands. 
Sample Texinfo Files
C.1 Short Sample  
C.2 GNU Sample Texts  
C.3 Verbatim Copying License  
C.4 All-permissive Copying License   
GNU Free Documentation License

Include Files
D.1 How to Use Include Files   How to use the @include command.
D.2 texinfo-multiple-files-update   How to create and update nodes and menus when using included files.
D.3 Include Files Requirements   texinfo-multiple-files-update needs.
D.4 Sample File with @include   A sample outer file with included files within it; and a sample included file.
D.5 Evolution of Include Files   How use of the @include command has changed over time. 
Page Headings
E.1 Headings Introduced   Conventions for using page headings.
E.2 Standard Heading Formats   Standard page heading formats.
E.3 Specifying the Type of Heading   How to specify the type of page heading.
E.4 How to Make Your Own Headings   How to create your own headings and footings. 
Formatting Mistakes
F.1 makeinfo Find Errors   makeinfo finds errors.
F.2 Catching Errors with Info Formatting   How to catch errors with Info formatting.
F.3 Catching Errors with TeX Formatting   How to catch errors with TeX formatting.
F.4 Using texinfo-show-structure   How to use texinfo-show-structure.
F.5 Using occur   How to list all lines containing a pattern.
F.6 Finding Badly Referenced Nodes   How to find badly referenced nodes. 
Finding Badly Referenced Nodes
F.6.1 Running Info-validate   How to run Info-validate.
F.6.2 Creating an Unsplit File   How to create an unsplit file.
F.6.3 Tagifying a File   How to tagify a file.
F.6.4 Splitting a File Manually   How to split a file manually. 



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









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




 
  This document was generated by Aidan Kehoe on December 27, 2016 using texi2html 1.82.