[Top] | [Contents] | [Index] | [ ? ] |
This manual is for GNU Texinfo (version 4.2, 28 March 2002), a documentation system that can produce both online information and a printed manual from a single source.
Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 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 freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development.”
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 | 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. 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. Conditionally Visible Text | How to specify text for either TeX or Info. | |
17. Internationalization | ||
18. Defining New Texinfo Commands | ||
19. Formatting and Printing Hardcopy | How to convert a Texinfo file to a file for printing and how to print that file. | |
20. Creating and Installing Info Files | ||
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. Refilling Paragraphs | All about paragraph refilling. | |
H. @-Command Syntax | A description of @-Command syntax. | |
I. How to Obtain TeX | ||
J. Copying This Manual | The GNU Free Documentation License. | |
Command and Variable Index | A menu containing commands and variables. | |
Concept 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 Info files | What is an Info file? | |
1.4 Printed Books | Characteristics of a printed book or manual. | |
1.5 @-commands | @-commands are used for formatting. | |
1.6 General Syntactic Conventions | General rules for writing a Texinfo file. | |
1.7 Comments | Writing comments and ignored text in general. | |
1.8 What a Texinfo File Must Have | What a Texinfo file must have. | |
1.9 Six Parts of a Texinfo File | Usually, a Texinfo file has six parts. | |
1.10 A Short Sample Texinfo File | A short sample Texinfo file. | |
1.11 History | Acknowledgements, contributors and genesis. | |
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 | ||
• 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 | ||
3.1 Sample Texinfo File Beginning | A sample beginning for a Texinfo file. | |
3.2 Texinfo File Header | ||
3.3 Document Permissions | ||
3.4 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 Global Document Commands | ||
3.7 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.5.1 Top Node Example | ||
3.5.2 Parts of a Master Menu | ||
Global Document Commands | ||
3.6.1 @documentdescription : Summary text | Document summary for the HTML output. | |
3.6.2 @setchapternewpage : | Start chapters on right-hand pages. | |
3.6.3 Paragraph Indenting | Specify paragraph indentation. | |
3.6.4 @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 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 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 | ||
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 | ||
• Menu Location | 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 | ||
• References | 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[, text][, replacement]} | How to refer to a uniform resource locator. | |
| ||
• Reference Syntax | 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. | ||
• Useful Highlighting | Highlighting provides useful information. | |
9.1.1 @code {sample-code} | Indicating program code. | |
9.1.2 @kbd {keyboard-characters} | Showing keyboard input. | |
9.1.3 @key {key-name} | Specifying keys. | |
9.1.4 @samp {text} | A literal sequence of characters. | |
9.1.5 @verb {<char>text<char>} | A verbatim sequence of characters. | |
9.1.6 @var {metasyntactic-variable} | Indicating metasyntactic variables. | |
9.1.7 @env {environment-variable} | Indicating environment variables. | |
9.1.8 @file {file-name} | Indicating file names. | |
9.1.9 @command {command-name} | Indicating command names. | |
9.1.10 @option {option-name} | Indicating option names. | |
9.1.11 @dfn {term} | Specifying definitions. | |
9.1.12 @cite {reference} | Referring to books not in the Info system. | |
9.1.13 @acronym {acronym} | Indicating acronyms. | |
9.1.14 @url {uniform-resource-locator} | Indicating a World Wide Web reference. | |
9.1.15 @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 | 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 | Forms for @smallbook .
| |
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 @cartouche : Rounded Rectangles Around Examples | Drawing rounded rectangles around examples. | |
Lists and Tables | ||
• Introducing Lists | Texinfo formats lists for you. | |
11.1 @itemize : Making an Itemized List | How to construct a simple list. | |
11.2 @enumerate : 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 | ||
• table | 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. | |
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 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 Footnotes | How to include footnotes. | |
13.11 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 and Bullets | ||
13.4.1 @dots {} (…) and @enddots {} (...) | 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 | ||
13.9.1 Glyphs Summary | ||
13.9.2 @result{} (⇒): Indicating Evaluation | How to show the result of expression. | |
13.9.3 @expansion{} (→): Indicating an Expansion | How to indicate an expansion. | |
13.9.4 @print{} (-|): Indicating Printed Output | How to indicate printed output. | |
13.9.5 @error{} (error-->): Indicating an Error Message | How to indicate an error message. | |
13.9.6 @equiv{} (≡): Indicating Equivalence | How to indicate equivalence. | |
13.9.7 @point{} (∗): Indicating Point in a Buffer | How to indicate the location of point. | |
Glyphs Summary | ||
13.9.2 @result{} (⇒): Indicating Evaluation | ||
13.9.3 @expansion{} (→): Indicating an Expansion | ||
13.9.4 @print{} (-|): Indicating Printed Output | ||
13.9.5 @error{} (error-->): Indicating an Error Message | ||
13.9.6 @equiv{} (≡): Indicating Equivalence | ||
13.9.7 @point{} (∗): Indicating Point in a Buffer | ||
Footnotes | ||
13.10.1 Footnote Commands | How to write a footnote in Texinfo. | |
13.10.2 Footnote Styles | Controlling how footnotes appear in Info. | |
Making and Preventing Breaks | ||
• 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. | |
Conditionally Visible Text | ||
16.1 Conditional Commands | Specifying text for HTML, Info, or TeX. | |
16.2 Conditional Not Commands | Specifying text for not HTML, Info, or TeX. | |
16.3 Raw Formatter Commands | Using raw TeX or HTML commands. | |
16.4 @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. | |
| ||
16.4.1 @set and @value | Expand a flag variable to a string. | |
16.4.2 @ifset and @ifclear | Format a region if a flag is set. | |
16.4.3 @value Example | An easy way to update edition information. | |
Internationalization | ||
17.1 @documentlanguage cc : Set the Document Language | Declaring the current language. | |
17.2 @documentencoding enc : Set Input Encoding | Declaring the input encoding. | |
Defining New Texinfo Commands | ||
18.1 Defining Macros | Defining and undefining new commands. | |
18.2 Invoking Macros | Using a macro, once you’ve defined it. | |
18.3 Macro Details | Beyond basic macro usage. | |
18.4 ‘@alias new=existing’ | Command aliases. | |
18.5 ‘definfoenclose’: Customized Highlighting | Customized highlighting. | |
Formatting and Printing Hardcopy | ||
19.1 Use TeX | Use TeX to format for hardcopy. | |
19.2 Format with tex and texindex | How to format with explicit shell commands. | |
19.3 Format with texi2dvi | A simpler way to format. | |
19.4 Shell Print Using lpr -d | How to print. | |
19.5 From an Emacs Shell | How to format and print from an Emacs shell. | |
19.6 Formatting and Printing in Texinfo Mode | How to format and print in Texinfo mode. | |
19.7 Using the Local Variables List | How to print using Emacs’s compile command. | |
19.8 TeX Formatting Requirements Summary | TeX formatting requirements summary. | |
19.9 Preparing for TeX | What to do before you use TeX. | |
19.10 Overfull “hboxes” | What are and what to do with overfull hboxes. | |
19.11 Printing “Small” Books | How to print small format books and manuals. | |
19.12 Printing on A4 Paper | How to print on A4 or A5 paper. | |
19.13 @pagesizes [width][, height]: Custom page sizes | How to print with customized page sizes. | |
19.14 Cropmarks and Magnification | How to print marks to indicate the size of pages and how to print scaled up output. | |
19.15 PDF Output | Portable Document Format output. | |
Creating and Installing Info Files | ||
20.1 Creating an Info File | ||
20.2 Installing an Info File | ||
Creating an Info File | ||
20.1.1 makeinfo Preferred | makeinfo provides better error checking.
| |
20.1.2 Running makeinfo from a Shell | How to run makeinfo from a shell.
| |
20.1.3 Options for makeinfo | Specify fill-column and other options. | |
20.1.4 Pointer Validation | How to check that pointers point somewhere. | |
20.1.5 Running makeinfo inside Emacs | How to run makeinfo from Emacs.
| |
20.1.6 The texinfo-format… Commands | Two Info formatting commands written
in Emacs Lisp are an alternative
to makeinfo .
| |
20.1.7 Batch Formatting | How to format for Info in Emacs Batch mode. | |
20.1.8 Tag Files and Split Files | How tagged and split files help Info to run better. | |
20.1.9 Generating HTML | Generating HTML output. | |
Installing an Info File | ||
20.2.1 The Directory File ‘dir’ | The top level menu for all Info files. | |
20.2.2 Listing a New Info File | Listing a new Info file. | |
20.2.3 Info Files in Other Directories | How to specify Info files that are located in other directories. | |
20.2.4 Installing Info Directory Files | How to specify what menu entry to add to the Info directory. | |
20.2.5 Invoking install-info | install-info options.
| |
Sample Texinfo Files | ||
C.1 Short Sample | ||
C.2 GNU Sample Texts | ||
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 File Requirements | What texinfo-multiple-files-update expects.
| |
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 | ||
• Headings Introduced | Conventions for using page headings. | |
E.1 Standard Heading Formats | Standard page heading formats. | |
E.2 Specifying the Type of Heading | How to specify the type of page heading. | |
E.3 How to Make Your Own Headings | How to create your own headings and footings. | |
Formatting Mistakes | ||
• makeinfo Preferred | makeinfo finds errors.
| |
F.1 Catching Errors with Info Formatting | How to catch errors with Info formatting. | |
F.2 Catching Errors with TeX Formatting | How to catch errors with TeX formatting. | |
F.3 Using texinfo-show-structure | How to use texinfo-show-structure .
| |
F.4 Using occur | How to list all lines containing a pattern. | |
F.5 Finding Badly Referenced Nodes | How to find badly referenced nodes. | |
Finding Badly Referenced Nodes | ||
F.5.1 Running Info-validate | How to run Info-validate .
| |
F.5.2 Creating an Unsplit File | How to create an unsplit file. | |
F.5.3 Tagifying a File | How to tagify a file. | |
F.5.4 Splitting a File Manually | How to split a file manually. | |
Copying This Manual | ||
J.1 GNU Free Documentation License | License for copying this manual. | |
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 a tester on a sunny day using texi2html.