diff options
Diffstat (limited to 'Master/texmf/doc/info/texinfo.info')
-rw-r--r-- | Master/texmf/doc/info/texinfo.info | 4579 |
1 files changed, 2833 insertions, 1746 deletions
diff --git a/Master/texmf/doc/info/texinfo.info b/Master/texmf/doc/info/texinfo.info index babfcb3c651..6f00c11e540 100644 --- a/Master/texmf/doc/info/texinfo.info +++ b/Master/texmf/doc/info/texinfo.info @@ -1,58 +1,46 @@ -This is texinfo.info, produced by makeinfo version 4.7 from texinfo.txi. +This is texinfo, produced by makeinfo version 4.12 from texinfo.txi. - This manual is for GNU Texinfo (version 4.7, 9 April 2004), a +This manual is for GNU Texinfo (version 4.12, 9 April 2008), a documentation system that can produce both online information and a printed manual from a single source. Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997, 1998, -1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc. +1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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) + Version 1.2 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." + (a) The FSF's Back-Cover Text is: "You are free to copy and modify + this GNU Manual. Buying copies from GNU Press supports the FSF in + developing GNU and promoting software freedom." INFO-DIR-SECTION Texinfo documentation system START-INFO-DIR-ENTRY * Texinfo: (texinfo). The GNU documentation format. * install-info: (texinfo)Invoking install-info. Update info/dir entries. * texi2dvi: (texinfo)Format with texi2dvi. Print Texinfo documents. +* texi2pdf: (texinfo)PDF Output. PDF output for Texinfo. +* pdftexi2dvi: (texinfo)PDF Output. PDF output for Texinfo. * texindex: (texinfo)Format with tex/texindex. Sort Texinfo index files. * makeinfo: (texinfo)Invoking makeinfo. Translate Texinfo source. END-INFO-DIR-ENTRY -File: texinfo.info, Node: Top, Next: Copying Conditions, Up: (dir) +File: texinfo, Node: Top, Next: Copying Conditions, Up: (dir) Texinfo ******* -This manual is for GNU Texinfo (version 4.7, 9 April 2004), a +This manual is for GNU Texinfo (version 4.12, 9 April 2008), a documentation system that can produce both online information and a printed manual from a single source. - Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997, 1998, -1999, 2000, 2001, 2002, 2003, 2004 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. @@ -91,9 +79,9 @@ menu lists all the lower level nodes in the document. * Include Files:: How to incorporate other Texinfo files. * Headings:: How to write page headings and footings. * Catching Mistakes:: How to find formatting mistakes. -* Copying This Manual:: The GNU Free Documentation License. +* GNU Free Documentation License::Copying this manual. * Command and Variable Index:: A menu containing commands and variables. -* Concept Index:: A menu covering many topics. +* General Index:: A menu covering many topics. --- The Detailed Node Listing --- @@ -273,6 +261,7 @@ Indicating Definitions, Commands, etc. * option:: Indicating option names. * dfn:: Specifying definitions. * cite:: Referring to books not in the Info system. +* abbr:: Indicating abbreviations. * acronym:: Indicating acronyms. * indicateurl:: Indicating a World Wide Web reference. * email:: Indicating an electronic mail address. @@ -360,15 +349,21 @@ Combining Indices Special Insertions * Atsign Braces Comma:: Inserting @ and {} and ,. +* Inserting Quote Characters:: Inserting left and right quotes, in code. * Inserting Space:: How to insert the right amount of space within a sentence. * Inserting Accents:: How to insert accents and special characters. +* Inserting Quotation Marks:: How to insert quotation marks. * Dots Bullets:: How to insert dots and bullets. * TeX and copyright:: How to insert the TeX logo and the copyright symbol. +* euro:: How to insert the Euro currency symbol. * pounds:: How to insert the pounds currency symbol. +* textdegree:: How to insert the degrees symbol. * minus:: How to insert a minus sign. +* geq leq:: How to insert greater/less-than-or-equal signs. * math:: How to format a mathematical expression. +* Click Sequences:: Inserting GUI usage sequences. * Glyphs:: How to indicate results of evaluation, expansion of macros, errors, etc. @@ -383,6 +378,7 @@ Inserting Space * Not Ending a Sentence:: Sometimes a . doesn't end a sentence. * Ending a Sentence:: Sometimes it does. * Multiple Spaces:: Inserting multiple spaces. +* frenchspacing:: Specifying end-of-sentence spacing. * dmn:: How to format a dimension. Inserting Ellipsis and Bullets @@ -420,6 +416,7 @@ Forcing and Preventing Breaks * Break Commands:: Summary of break-related commands. * Line Breaks:: Forcing line breaks. * - and hyphenation:: Helping TeX with hyphenation points. +* allowcodebreaks:: Controlling line breaks within @code text. * w:: Preventing unwanted line breaks in text. * tie:: Inserting an unbreakable but varying space. * sp:: Inserting blank lines. @@ -553,9 +550,7 @@ Sample Texinfo Files * Verbatim Copying License:: * All-permissive Copying License:: -Copying This Manual - -* GNU Free Documentation License:: License for copying this manual. +GNU Free Documentation License Include Files @@ -591,15 +586,11 @@ Finding Badly Referenced Nodes * Tagifying:: How to tagify a file. * Splitting:: How to split a file manually. -Copying This Manual - -* 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 -File: texinfo.info, Node: Copying Conditions, Next: Overview, Prev: Top, Up: Top +File: texinfo, Node: Copying Conditions, Next: Overview, Prev: Top, Up: Top Texinfo Copying Conditions ************************** @@ -640,7 +631,7 @@ the GNU Free Documentation License (*note GNU Free Documentation License::). -File: texinfo.info, Node: Overview, Next: Texinfo Mode, Prev: Copying Conditions, Up: Top +File: texinfo, Node: Overview, Next: Texinfo Mode, Prev: Copying Conditions, Up: Top 1 Overview of Texinfo ********************* @@ -678,7 +669,7 @@ Texinfo as if the `x' were a `k'. Spell "Texinfo" with a capital "T" and the other letters in lower case. -File: texinfo.info, Node: Reporting Bugs, Next: Using Texinfo, Up: Overview +File: texinfo, Node: Reporting Bugs, Next: Using Texinfo, Up: Overview 1.1 Reporting Bugs ================== @@ -709,16 +700,11 @@ better to include too much than to leave out something important. Patches are most welcome; if possible, please make them with `diff -c' (*note Overview: (diff)Top.) and include `ChangeLog' entries -(*note Change Log: (emacs)Change Log.). - - When sending patches, if possible please do not encode or split them -in any way; it's much easier to deal with one plain text message, -however large, than many small ones. GNU shar -(ftp://ftp.gnu.org/gnu/sharutils/) is a convenient way of packaging -multiple and/or binary files for email. +(*note Change Log: (emacs)Change Log.), and follow the existing coding +style. -File: texinfo.info, Node: Using Texinfo, Next: Output Formats, Prev: Reporting Bugs, Up: Overview +File: texinfo, Node: Using Texinfo, Next: Output Formats, Prev: Reporting Bugs, Up: Overview 1.2 Using Texinfo ================= @@ -750,7 +736,7 @@ information is available at the GNU documentation web page (http://www.gnu.org/doc/). -File: texinfo.info, Node: Output Formats, Next: Info Files, Prev: Using Texinfo, Up: Overview +File: texinfo, Node: Output Formats, Next: Info Files, Prev: Using Texinfo, Up: Overview 1.3 Output Formats ================== @@ -772,7 +758,7 @@ Info Plain text (Generated via `makeinfo --no-headers'.) This is almost the same as Info output, except the navigational control characters are - omitted. + omitted. Also, standard output is used by default. HTML (Generated via `makeinfo --html'.) This is the Hyper Text Markup @@ -800,18 +786,21 @@ DVI `http://savannah.gnu.org/projects/teximpatient'. PDF - (Generated via `texi2dvi --pdf'.) This format, based on - PostScript, was developed by Adobe Systems for document - interchange. It is intended to be platform-independent and easily - viewable, among other design goals; for a discussion, see - `http://tug.org/tugboat/Articles/tb22-3/tb72beebeI.pdf'. Texinfo - uses the `pdftex' program, a variant of TeX, to output pdf; see - `http://tug.org/applications/pdftex'. *Note PDF Output::. + (Generated via `texi2dvi --pdf' or `texi2pdf'.) This format was + developed by Adobe Systems for portable document interchange, + based on their previous PostScript language. It can represent the + exact appearance of a document, including fonts and graphics, and + supporting arbitrary scaling. It is intended to be + platform-independent and easily viewable, among other design goals; + `http://tug.org/TUGboat/Articles/tb22-3/tb72beebe-pdf.pdf' has + some background. Texinfo uses the `pdftex' program, a variant of + TeX, to output PDF; see `http://tug.org/applications/pdftex'. + *Note PDF Output::. XML (Generated via `makeinfo --xml'.) XML is a generic syntax specification usable for any sort of content (see, for example, - `http://www.w3.org/XML/'). The `makeinfo' xml output, unlike all + `http://www.w3.org/XML/'). The `makeinfo' XML output, unlike all the formats above, interprets very little of the Texinfo source. Rather, it merely translates the Texinfo markup commands into XML syntax, for processing by further XML tools. The particular @@ -853,7 +842,7 @@ language is continually being enhanced and updated. Instead, the best approach is modify `makeinfo' to generate the new format. -File: texinfo.info, Node: Info Files, Next: Printed Books, Prev: Output Formats, Up: Overview +File: texinfo, Node: Info Files, Next: Printed Books, Prev: Output Formats, Up: Overview 1.4 Info Files ============== @@ -937,7 +926,7 @@ Emacs/W3, for example: info:emacs#Dissociated%20Press info://localhost/usr/info/emacs#Dissociated%20Press - The `info' program itself does not follow URI's of any kind. + The `info' program itself does not follow URIs of any kind. ---------- Footnotes ---------- @@ -946,7 +935,7 @@ Occasionally, the last child has the node name of the next following higher level node as its `Next' pointer. -File: texinfo.info, Node: Printed Books, Next: Formatting Commands, Prev: Info Files, Up: Overview +File: texinfo, Node: Printed Books, Next: Formatting Commands, Prev: Info Files, Up: Overview 1.5 Printed Books ================= @@ -972,15 +961,15 @@ that TeX uses when it typesets a Texinfo file. (`texinfo.tex' tells TeX how to convert the Texinfo @-commands to TeX commands, which TeX can then process to create the typeset document.) `texinfo.tex' contains the specifications for printing a document. You can get the -latest version of `texinfo.tex' from -`ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex'. +latest version of `texinfo.tex' from the Texinfo home page, +`http://www.gnu.org/software/texinfo/'. In the United States, documents are most often printed on 8.5 inch by 11 inch pages (216mm by 280mm); this is the default size. But you can also print for 7 inch by 9.25 inch pages (178mm by 235mm, the `@smallbook' size; or on A4 or A5 size paper (`@afourpaper', `@afivepaper'). (*Note Printing "Small" Books: smallbook. Also, see -*Note Printing on A4 Paper: A4 Paper.) +*note Printing on A4 Paper: A4 Paper.) By changing the parameters in `texinfo.tex', you can change the size of the printed document. In addition, you can change the style in @@ -1000,7 +989,7 @@ Texinfo file must be able to present information both on a character-only terminal in Info form and in a typeset book, the formatting commands that Texinfo supports are necessarily limited. - To get a copy of TeX, see *Note How to Obtain TeX: Obtaining TeX. + To get a copy of TeX, see *note How to Obtain TeX: Obtaining TeX. ---------- Footnotes ---------- @@ -1011,7 +1000,7 @@ standard GNU distribution and is not maintained or up-to-date with all the Texinfo features described in this manual. -File: texinfo.info, Node: Formatting Commands, Next: Conventions, Prev: Printed Books, Up: Overview +File: texinfo, Node: Formatting Commands, Next: Conventions, Prev: Printed Books, Up: Overview 1.6 @-commands ============== @@ -1044,7 +1033,7 @@ write @-commands on lines of their own or as part of sentences: titles.) * Write a command such as `@dots{}' wherever you wish but usually - within a sentence. (`@dots{}' creates dots ...) + within a sentence. (`@dots{}' creates an ellipsis ...) * Write a command such as `@code{SAMPLE-CODE}' wherever you wish (but usually within a sentence) with its argument, SAMPLE-CODE in @@ -1084,7 +1073,7 @@ assert in a manner against which others may make counter assertions', which led to the meaning of `argument' as a dispute. -File: texinfo.info, Node: Conventions, Next: Comments, Prev: Formatting Commands, Up: Overview +File: texinfo, Node: Conventions, Next: Comments, Prev: Formatting Commands, Up: Overview 1.7 General Syntactic Conventions ================================= @@ -1107,51 +1096,37 @@ documents. `@noindent' to inhibit paragraph indentation if required (*note `@noindent': noindent.). - * Use doubled single-quote characters to begin and end quotations: - ``...''. TeX converts two single quotes to left- and right-hand - doubled quotation marks, and Info converts doubled single-quote - characters to ASCII double-quotes: ``...'' becomes "...". - - You may occasionally need to produce two consecutive single quotes; - for example, in documenting a computer language such as Maxima - where '' is a valid command. You can do this with the input - '@w{}'; the empty `@w' command stops the combination into the - double-quote characters. - - The left quote character (`, ASCII code 96) used in Texinfo is a - grave accent in ANSI and ISO character set standards. We use it - as a quote character because that is how TeX is set up, by - default. We hope to eventually support the various quotation - characters in Unicode. + * Texinfo supports the usual quotation marks used in English, and + quotation marks used in other languages, please see *note + Inserting Quotation Marks::. * Use three hyphens in a row, `---', to produce a long dash--like this (called an "em dash"), used for punctuation in sentences. - Use two hyphens, `--', to produce a medium dash-like this (called - an "en dash"), used to separate numeric ranges. Use a single - hyphen, `-', to produce a standard hyphen used in compound words. - For display on the screen, Info reduces three hyphens to two and - two hyphens to one (not transitively!). Of course, any number of - hyphens in the source remain as they are in literal contexts, such - as `@code' and `@example'. - - * *Caution:* Last and most important, do not use tab characters in a - Texinfo file (except in verbatim modes)! TeX uses variable-width - fonts, which means that it is impractical at best to define a tab - to work in all circumstances. Consequently, TeX treats tabs like - single spaces, and that is not what they look like in the source. - Furthermore, `makeinfo' does nothing special with tabs, and thus a - tab character in your input file will usually appear differently - in the output. - - To avoid this problem, Texinfo mode causes GNU Emacs to insert - multiple spaces when you press the <TAB> key. + Use two hyphens, `--', to produce a medium dash (called an "en + dash"), used primarily for numeric ranges, as in "June 25-26". + Use a single hyphen, `-', to produce a standard hyphen used in + compound words. For display on the screen, Info reduces three + hyphens to two and two hyphens to one (not transitively!). Of + course, any number of hyphens in the source remain as they are in + literal contexts, such as `@code' and `@example'. + + * *Caution:* Last, do not use tab characters in a Texinfo file + (except in verbatim modes)! TeX uses variable-width fonts, which + means that it is impractical at best to define a tab to work in all + circumstances. Consequently, TeX treats tabs like single spaces, + and that is not what they look like in the source. Furthermore, + `makeinfo' does nothing special with tabs, and thus a tab + character in your input file will usually appear differently in the + output. - Also, you can run `untabify' in Emacs to convert tabs in a region - to multiple spaces, or use the `unexpand' command from the shell. + To avoid this problem, Texinfo mode in GNU Emacs inserts multiple + spaces when you press the <TAB> key. Also, you can run `untabify' + in Emacs to convert tabs in a region to multiple spaces, or use + the `unexpand' command from the shell. -File: texinfo.info, Node: Comments, Next: Minimum, Prev: Conventions, Up: Overview +File: texinfo, Node: Comments, Next: Minimum, Prev: Conventions, Up: Overview 1.8 Comments ============ @@ -1184,12 +1159,12 @@ the source file; that means that you may still get error messages if you have invalid Texinfo commands within ignored text. -File: texinfo.info, Node: Minimum, Next: Six Parts, Prev: Comments, Up: Overview +File: texinfo, Node: Minimum, Next: Six Parts, Prev: Comments, Up: Overview 1.9 What a Texinfo File Must Have ================================= -By convention, the namea of a Texinfo file ends with (in order of +By convention, the name of a Texinfo file ends with (in order of preference) one of the extensions `.texinfo', `.texi', `.txi', or `.tex'. The longer extensions are preferred since they describe more clearly to a human reader the nature of the file. The shorter @@ -1251,7 +1226,7 @@ But the minimum, which can be useful for short documents, is just the three lines at the beginning and the one line at the end. -File: texinfo.info, Node: Six Parts, Next: Short Sample, Prev: Minimum, Up: Overview +File: texinfo, Node: Six Parts, Next: Short Sample, Prev: Minimum, Up: Overview 1.10 Six Parts of a Texinfo File ================================ @@ -1288,12 +1263,11 @@ sections. traditional book or encyclopedia, but it may be free form. 6. End - The "End" segment contains commands for printing indices and - generating the table of contents, and the `@bye' command on a line - of its own. + The "End" segment may contain commands for printing indices, and + closes with the `@bye' command on a line of its own. -File: texinfo.info, Node: Short Sample, Next: History, Prev: Six Parts, Up: Overview +File: texinfo, Node: Short Sample, Next: History, Prev: Six Parts, Up: Overview 1.11 A Short Sample Texinfo File ================================ @@ -1311,7 +1285,7 @@ in GNU manuals. In the following, the sample text is _indented_; comments on it are not. The complete file, without interspersed comments, is shown in -*Note Short Sample Texinfo File::. +*note Short Sample Texinfo File::. Part 1: Header -------------- @@ -1335,7 +1309,7 @@ which it is distributed. *Note GNU Sample Texts::. @copying This is a short example of a complete Texinfo file, version 1.0. - Copyright @copyright{} 2004 Free Software Foundation, Inc. + Copyright @copyright{} 2005 Free Software Foundation, Inc. @end copying Part 3: Titlepage, Contents, Copyright @@ -1364,17 +1338,16 @@ Part 4: `Top' Node and Master Menu The `Top' node contains the master menu for the Info file. Since the printed manual uses a table of contents rather than a menu, it excludes -the `Top' node. We also include the copying text again for the benefit -of online readers. Since the copying text begins with a brief -description of the manual, no other text is needed in this case. The -`@top' command itself helps `makeinfo' determine the relationships -between nodes. +the `Top' node. We repeat the short description from the beginning of +the `@copying' text, but there's no need to repeat the copyright +information, so we don't use `@insertcopying' here. The `@top' command +itself helps `makeinfo' determine the relationships between nodes. @ifnottex @node Top @top Short Sample - @insertcopying + This is a short sample Texinfo file. @end ifnottex @menu @@ -1437,7 +1410,7 @@ Here is what the contents of the first chapter of the sample look like: 2. This is the second item. -File: texinfo.info, Node: History, Prev: Short Sample, Up: Overview +File: texinfo, Node: History, Prev: Short Sample, Up: Overview 1.12 History ============ @@ -1463,7 +1436,7 @@ patches and suggestions, they are gratefully acknowledged in the A bit of history: in the 1970's at CMU, Brian Reid developed a program and format named Scribe to mark up documents for printing. It used the `@' character to introduce commands, as Texinfo does. Much more -consequentially, it strived to describe document contents rather than +consequentially, it strove to describe document contents rather than formatting, an idea wholeheartedly adopted by Texinfo. Meanwhile, people at MIT developed another, not too dissimilar format @@ -1479,7 +1452,7 @@ up language for text that is intended to be read both online and as printed hard copy. -File: texinfo.info, Node: Texinfo Mode, Next: Beginning a File, Prev: Overview, Up: Top +File: texinfo, Node: Texinfo Mode, Next: Beginning a File, Prev: Overview, Up: Top 2 Using Texinfo Mode ******************** @@ -1508,7 +1481,7 @@ chapters which describe the Texinfo formatting language in detail. * Texinfo Mode Summary:: Summary of all the Texinfo mode commands. -File: texinfo.info, Node: Texinfo Mode Overview, Next: Emacs Editing, Up: Texinfo Mode +File: texinfo, Node: Texinfo Mode Overview, Next: Emacs Editing, Up: Texinfo Mode 2.1 Texinfo Mode Overview ========================= @@ -1537,7 +1510,7 @@ You can: frequently used @-commands and for creating node pointers and menus. -File: texinfo.info, Node: Emacs Editing, Next: Inserting, Prev: Texinfo Mode Overview, Up: Texinfo Mode +File: texinfo, Node: Emacs Editing, Next: Inserting, Prev: Texinfo Mode Overview, Up: Texinfo Mode 2.2 The Usual GNU Emacs Editing Commands ======================================== @@ -1558,7 +1531,7 @@ expression matching the commands for chapters and their equivalents, such as appendices. With this value for the page delimiter, you can jump from chapter title to chapter title with the `C-x ]' (`forward-page') and `C-x [' (`backward-page') commands and narrow to a -chapter with the `C-x p' (`narrow-to-page') command. (*Note Pages: +chapter with the `C-x n p' (`narrow-to-page') command. (*Note Pages: (emacs)Pages, for details about the page commands.) You may name a Texinfo file however you wish, but the convention is to @@ -1578,7 +1551,7 @@ change. The keybindings described here are the default or standard ones. -File: texinfo.info, Node: Inserting, Next: Showing the Structure, Prev: Emacs Editing, Up: Texinfo Mode +File: texinfo, Node: Inserting, Next: Showing the Structure, Prev: Emacs Editing, Up: Texinfo Mode 2.3 Inserting Frequently Used Commands ====================================== @@ -1646,13 +1619,13 @@ first letter of the @-command: `M-x texinfo-insert-braces' Insert `{}' and put the cursor between the braces. -`C-c C-c }' -`C-c C-c ]' +`C-c }' +`C-c ]' `M-x up-list' Move from between a pair of braces forward past the closing brace. - Typing `C-c C-c ]' is easier than typing `C-c C-c }', which is, - however, more mnemonic; hence the two keybindings. (Also, you can - move out from between braces by typing `C-f'.) + Typing `C-c ]' is easier than typing `C-c }', which is, however, + more mnemonic; hence the two keybindings. (Also, you can move out + from between braces by typing `C-f'.) To put a command such as `@code{...}' around an _existing_ word, position the cursor in front of the word and type `C-u 1 C-c C-c c'. @@ -1692,7 +1665,7 @@ use the same words as a node name but a useful description uses different words. -File: texinfo.info, Node: Showing the Structure, Next: Updating Nodes and Menus, Prev: Inserting, Up: Texinfo Mode +File: texinfo, Node: Showing the Structure, Next: Updating Nodes and Menus, Prev: Inserting, Up: Texinfo Mode 2.4 Showing the Section Structure of a File =========================================== @@ -1735,12 +1708,12 @@ information about the narrowing commands.) Texinfo mode sets the value of the page delimiter variable to match the chapter-level @-commands. This enables you to use the `C-x ]' (`forward-page') and `C-x [' (`backward-page') commands to move forward -and backward by chapter, and to use the `C-x p' (`narrow-to-page') +and backward by chapter, and to use the `C-x n p' (`narrow-to-page') command to narrow to a chapter. *Note Pages: (emacs)Pages, for more information about the page commands. -File: texinfo.info, Node: Updating Nodes and Menus, Next: Info Formatting, Prev: Showing the Structure, Up: Texinfo Mode +File: texinfo, Node: Updating Nodes and Menus, Next: Info Formatting, Prev: Showing the Structure, Up: Texinfo Mode 2.5 Updating Nodes and Menus ============================ @@ -1765,7 +1738,7 @@ node pointers by hand, which is a tedious task. nodes in sequence. -File: texinfo.info, Node: Updating Commands, Next: Updating Requirements, Up: Updating Nodes and Menus +File: texinfo, Node: Updating Commands, Next: Updating Requirements, Up: Updating Nodes and Menus 2.5.1 The Updating Commands --------------------------- @@ -1896,7 +1869,7 @@ file. The `texinfo-column-for-description' variable specifies the column to which menu descriptions are indented. By default, the value is 32 -although it is often useful to reduce it to as low as 24. You can set +although it can be useful to reduce it to as low as 24. You can set the variable via customization (*note Changing an Option: (emacs)Changing an Option.) or with the `M-x set-variable' command (*note Examining and Setting Variables: (emacs)Examining.). @@ -1908,7 +1881,7 @@ missing `@node' lines into a file. (*Note Other Updating Commands::, for more information.) -File: texinfo.info, Node: Updating Requirements, Next: Other Updating Commands, Prev: Updating Commands, Up: Updating Nodes and Menus +File: texinfo, Node: Updating Requirements, Next: Other Updating Commands, Prev: Updating Commands, Up: Updating Nodes and Menus 2.5.2 Updating Requirements --------------------------- @@ -1964,7 +1937,7 @@ commands. (*Note Creating an Info File::, for more information about commands require that you insert menus in the file. -File: texinfo.info, Node: Other Updating Commands, Prev: Updating Requirements, Up: Updating Nodes and Menus +File: texinfo, Node: Other Updating Commands, Prev: Updating Requirements, Up: Updating Nodes and Menus 2.5.3 Other Updating Commands ----------------------------- @@ -2030,7 +2003,7 @@ several less frequently used updating commands: the nodes in the region. -File: texinfo.info, Node: Info Formatting, Next: Printing, Prev: Updating Nodes and Menus, Up: Texinfo Mode +File: texinfo, Node: Info Formatting, Next: Printing, Prev: Updating Nodes and Menus, Up: Texinfo Mode 2.6 Formatting for Info ======================= @@ -2076,7 +2049,7 @@ include a line that has `@setfilename' in its header. *Note Creating an Info File::, for details about Info formatting. -File: texinfo.info, Node: Printing, Next: Texinfo Mode Summary, Prev: Info Formatting, Up: Texinfo Mode +File: texinfo, Node: Printing, Next: Texinfo Mode Summary, Prev: Info Formatting, Up: Texinfo Mode 2.7 Printing ============ @@ -2130,7 +2103,7 @@ line with start-of-header and end-of-header lines.) commands, such as `tex-show-print-queue'. -File: texinfo.info, Node: Texinfo Mode Summary, Prev: Printing, Up: Texinfo Mode +File: texinfo, Node: Texinfo Mode Summary, Prev: Printing, Up: Texinfo Mode 2.8 Texinfo Mode Summary ======================== @@ -2154,9 +2127,9 @@ is quick to type.) C-c C-c n Insert `@node'. C-c C-c s Insert `@samp'. C-c C-c v Insert `@var'. - C-c C-c { Insert braces. - C-c C-c ] - C-c C-c } Move out of enclosing braces. + C-c { Insert braces. + C-c ] + C-c } Move out of enclosing braces. C-c C-c C-d Insert a node's section title in the space for the description @@ -2275,7 +2248,7 @@ they are rarely used. Insert node pointers in strict sequence. -File: texinfo.info, Node: Beginning a File, Next: Ending a File, Prev: Texinfo Mode, Up: Top +File: texinfo, Node: Beginning a File, Next: Ending a File, Prev: Texinfo Mode, Up: Top 3 Beginning a Texinfo File ************************** @@ -2307,7 +2280,7 @@ and so on. have the right to use and share software. -File: texinfo.info, Node: Sample Beginning, Next: Texinfo File Header, Up: Beginning a File +File: texinfo, Node: Sample Beginning, Next: Texinfo File Header, Up: Beginning a File 3.1 Sample Texinfo File Beginning ================================= @@ -2358,7 +2331,7 @@ manuals. @node Top @top TITLE - @insertcopying + This manual is for PROGRAM, version VERSION. @end ifnottex @menu @@ -2376,7 +2349,7 @@ manuals. ... -File: texinfo.info, Node: Texinfo File Header, Next: Document Permissions, Prev: Sample Beginning, Up: Beginning a File +File: texinfo, Node: Texinfo File Header, Next: Document Permissions, Prev: Sample Beginning, Up: Beginning a File 3.2 Texinfo File Header ======================= @@ -2412,7 +2385,7 @@ Texts::, for complete sample texts. * End of Header:: Formatting a region requires this. -File: texinfo.info, Node: First Line, Next: Start of Header, Up: Texinfo File Header +File: texinfo, Node: First Line, Next: Start of Header, Up: Texinfo File Header 3.2.1 The First Line of a Texinfo File -------------------------------------- @@ -2437,7 +2410,7 @@ This line serves two functions: specification tells Emacs to use Texinfo mode. -File: texinfo.info, Node: Start of Header, Next: setfilename, Prev: First Line, Up: Texinfo File Header +File: texinfo, Node: Start of Header, Next: setfilename, Prev: First Line, Up: Texinfo File Header 3.2.2 Start of Header --------------------- @@ -2461,7 +2434,7 @@ change it if you wish by setting the `tex-start-of-header' and/or `tex-end-of-header' Emacs variables. *Note Texinfo Mode Printing::. -File: texinfo.info, Node: setfilename, Next: settitle, Prev: Start of Header, Up: Texinfo File Header +File: texinfo, Node: setfilename, Next: settitle, Prev: Start of Header, Up: Texinfo File Header 3.2.3 `@setfilename': Set the output file name ---------------------------------------------- @@ -2510,7 +2483,7 @@ reads `texinfo.cnf' if that file is present on your system (*note Preparing for TeX: Preparing for TeX.). -File: texinfo.info, Node: settitle, Next: End of Header, Prev: setfilename, Up: Texinfo File Header +File: texinfo, Node: settitle, Next: End of Header, Prev: setfilename, Up: Texinfo File Header 3.2.4 `@settitle': Set the document title ----------------------------------------- @@ -2560,7 +2533,7 @@ Command: headings on off, for more information.) footings. *Note Headings::, for a detailed discussion of this. -File: texinfo.info, Node: End of Header, Prev: settitle, Up: Texinfo File Header +File: texinfo, Node: End of Header, Prev: settitle, Up: Texinfo File Header 3.2.5 End of Header ------------------- @@ -2573,7 +2546,7 @@ comment that looks like this: *Note Start of Header::. -File: texinfo.info, Node: Document Permissions, Next: Titlepage & Copyright Page, Prev: Texinfo File Header, Up: Beginning a File +File: texinfo, Node: Document Permissions, Next: Titlepage & Copyright Page, Prev: Texinfo File Header, Up: Beginning a File 3.3 Document Permissions ======================== @@ -2590,7 +2563,7 @@ appropriate points. * insertcopying:: Where to insert the permissions. -File: texinfo.info, Node: copying, Next: insertcopying, Up: Document Permissions +File: texinfo, Node: copying, Next: insertcopying, Up: Document Permissions 3.3.1 `@copying': Declare Copying Permissions --------------------------------------------- @@ -2646,16 +2619,17 @@ separated by commas. the work. In the case of works assigned to the FSF, the owner is `Free Software Foundation, Inc.'. - The copyright `line' may actually be split across multiple lines, -both in the source document and in the output. This often happens for + The copyright `line' may actually be split across multiple lines, both +in the source document and in the output. This often happens for documents with a long history, having many different years of -publication. +publication. If you do use several lines, do not indent any of them +(or anything else in the `@copying' block) in the source file. *Note Copyright Notices: (maintain)Copyright Notices, for additional information. -File: texinfo.info, Node: insertcopying, Prev: copying, Up: Document Permissions +File: texinfo, Node: insertcopying, Prev: copying, Up: Document Permissions 3.3.2 `@insertcopying': Include Permissions Text ------------------------------------------------ @@ -2669,30 +2643,22 @@ like this: legal requirements, it must be used on the copyright page in the printed manual (*note Copyright::). - We also strongly recommend using `@insertcopying' in the Top node of -your manual (*note The Top Node::), although it is not required -legally. Here's why: - The `@copying' command itself causes the permissions text to appear in an Info file _before_ the first node. The text is also copied into the beginning of each split Info output file, as is legally necessary. This location implies a human reading the manual using Info does _not_ -see this text (except when using the advanced Info command `g *'). -Therefore, an explicit `@insertcopying' in the Top node makes it -apparent to readers that the manual is free. +see this text (except when using the advanced Info command `g *'), but +this does not matter for legal purposes, because the text is present. Similarly, the `@copying' text is automatically included at the beginning of each HTML output file, as an HTML comment. Again, this -text is not visible (unless the reader views the HTML source). And -therefore again, the `@insertcopying' in the Top node is valuable -because it makes the copying permissions visible and thus promotes -freedom. +text is not visible (unless the reader views the HTML source). The permissions text defined by `@copying' also appears automatically at the beginning of the XML output file. -File: texinfo.info, Node: Titlepage & Copyright Page, Next: Contents, Prev: Document Permissions, Up: Beginning a File +File: texinfo, Node: Titlepage & Copyright Page, Next: Contents, Prev: Document Permissions, Up: Beginning a File 3.4 Title and Copyright Pages ============================= @@ -2727,7 +2693,7 @@ text (`--no-headers'), along with an `@insertcopying'. and double or single sided printing. -File: texinfo.info, Node: titlepage, Next: titlefont center sp, Up: Titlepage & Copyright Page +File: texinfo, Node: titlepage, Next: titlefont center sp, Up: Titlepage & Copyright Page 3.4.1 `@titlepage' ------------------ @@ -2756,7 +2722,7 @@ If the manual changes more frequently than the program or is independent of it, you should also include an edition number(1) for the manual. This helps readers keep track of which manual is for which version of the program. (The `Top' node should also contain this information; see -*Note The Top Node::.) +*note The Top Node::.) Texinfo provides two main methods for creating a title page. One method uses the `@titlefont', `@sp', and `@center' commands to generate @@ -2786,7 +2752,7 @@ conversation by referring to both the documentation and the software with the same words. -File: texinfo.info, Node: titlefont center sp, Next: title subtitle author, Prev: titlepage, Up: Titlepage & Copyright Page +File: texinfo, Node: titlefont center sp, Next: title subtitle author, Prev: titlepage, Up: Titlepage & Copyright Page 3.4.2 `@titlefont', `@center', and `@sp' ---------------------------------------- @@ -2841,7 +2807,7 @@ for more information about the `@sp' command.) but since they are not logical markup commands, we don't recommend them. -File: texinfo.info, Node: title subtitle author, Next: Copyright, Prev: titlefont center sp, Up: Titlepage & Copyright Page +File: texinfo, Node: title subtitle author, Next: Copyright, Prev: titlefont center sp, Up: Titlepage & Copyright Page 3.4.3 `@title', `@subtitle', and `@author' ------------------------------------------ @@ -2911,10 +2877,10 @@ be useful if you have a very long title. Here is a real-life example: @author by Daniel Hagerty, Melissa Weisshaus @author and Eli Zaretskii -(The use of `@value' here is explained in *Note value Example::. +(The use of `@value' here is explained in *note value Example::. -File: texinfo.info, Node: Copyright, Next: end titlepage, Prev: title subtitle author, Up: Titlepage & Copyright Page +File: texinfo, Node: Copyright, Next: end titlepage, Prev: title subtitle author, Up: Titlepage & Copyright Page 3.4.4 Copyright Page -------------------- @@ -2927,7 +2893,7 @@ should be within `@titlepage' and `@end titlepage' commands. Use the `@page' command to cause a page break. To push the copyright notice and the other text on the copyright page towards the bottom of -the page, use the following incantantion after `@page': +the page, use the following incantation after `@page': @vskip 0pt plus 1filll @@ -2960,12 +2926,14 @@ credits, and other such information. @end titlepage -File: texinfo.info, Node: end titlepage, Next: headings on off, Prev: Copyright, Up: Titlepage & Copyright Page +File: texinfo, Node: end titlepage, Next: headings on off, Prev: Copyright, Up: Titlepage & Copyright Page 3.4.5 Heading Generation ------------------------ -The `@end titlepage' command must be written on a line by itself. It +Like all `@end' commands (*note Quotations and Examples::), the `@end +titlepage' command must be written at the beginning of a line by +itself, with only one space between the `@end' and the `titlepage'. It not only marks the end of the title and copyright pages, but also causes TeX to start generating page headings and page numbers. @@ -2995,7 +2963,7 @@ double-sided format, using `@setchapternewpage odd' for double-sided printing and no `@setchapternewpage' command for single-sided printing. -File: texinfo.info, Node: headings on off, Prev: end titlepage, Up: Titlepage & Copyright Page +File: texinfo, Node: headings on off, Prev: end titlepage, Up: Titlepage & Copyright Page 3.4.6 The `@headings' Command ----------------------------- @@ -3004,7 +2972,7 @@ The `@headings' command is rarely used. It specifies what kind of page headings and footings to print on each page. Usually, this is controlled by the `@setchapternewpage' command. You need the `@headings' command only if the `@setchapternewpage' command does not -do what you want, or if you want to turn off pre-defined page headings +do what you want, or if you want to turn off predefined page headings prior to defining your own. Write an `@headings' command immediately after the `@end titlepage' command. @@ -3017,10 +2985,7 @@ after the `@end titlepage' command. Turn on page headings appropriate for single-sided printing. `@headings double' -`@headings on' - Turn on page headings appropriate for double-sided printing. The - two commands, `@headings on' and `@headings double', are - synonymous. + Turn on page headings appropriate for double-sided printing. `@headings singleafter' `@headings doubleafter' @@ -3052,7 +3017,7 @@ which would otherwise cause TeX to print page headings. *Note Page Headings: Headings, for more information. -File: texinfo.info, Node: Contents, Next: The Top Node, Prev: Titlepage & Copyright Page, Up: Beginning a File +File: texinfo, Node: Contents, Next: The Top Node, Prev: Titlepage & Copyright Page, Up: Beginning a File 3.5 Generating a Table of Contents ================================== @@ -3092,7 +3057,7 @@ formatting commands ignore the contents commands. But the contents are included in plain text output (generated by `makeinfo --no-headers'), unless `makeinfo' is writing its output to standard output. - When `makeinfo' writes a short table of contents while producing html + When `makeinfo' writes a short table of contents while producing HTML output, the links in the short table of contents point to corresponding entries in the full table of contents rather than the text of the document. The links in the full table of contents point to the main @@ -3119,28 +3084,28 @@ this without altering the source file at all. For example: texi2dvi --texinfo=@setcontentsaftertitlepage foo.texi -File: texinfo.info, Node: The Top Node, Next: Global Document Commands, Prev: Contents, Up: Beginning a File +File: texinfo, Node: The Top Node, Next: Global Document Commands, Prev: Contents, Up: Beginning a File 3.6 The `Top' Node and Master Menu ================================== The `Top' node is the node in which a reader enters an Info manual. As -such, it should begin with the `@insertcopying' command (*note Document -Permissions::) to provide a brief description of the manual (including -the version number) and copying permissions, and end with a master menu -for the whole manual. Of course you should include any other general -information you feel a reader would find helpful. +such, it should begin with a brief description of the manual (including +the version number), and end with a master menu for the whole manual. +Of course you should include any other general information you feel a +reader would find helpful. - It is also conventional to write an `@top' sectioning command line -containing the title of the document immediately after the `@node Top' -line (*note The `@top' Sectioning Command: makeinfo top command.). + It is conventional and desirable to write an `@top' sectioning +command line containing the title of the document immediately after the +`@node Top' line (*note The `@top' Sectioning Command: makeinfo top +command.). The contents of the `Top' node should appear only in the online output; none of it should appear in printed output, so enclose it between `@ifnottex' and `@end ifnottex' commands. (TeX does not print either an `@node' line or a menu; they appear only in Info; strictly speaking, you are not required to enclose these parts between -`@ifnottex' and `@end ifnottext', but it is simplest to do so. *Note +`@ifnottex' and `@end ifnottex', but it is simplest to do so. *Note Conditionally Visible Text: Conditionals.) * Menu: @@ -3149,7 +3114,7 @@ Conditionally Visible Text: Conditionals.) * Master Menu Parts:: -File: texinfo.info, Node: Top Node Example, Next: Master Menu Parts, Up: The Top Node +File: texinfo, Node: Top Node Example, Next: Master Menu Parts, Up: The Top Node 3.6.1 Top Node Example ---------------------- @@ -3161,6 +3126,7 @@ Here is an example of a Top node. @top Sample Title @insertcopying + @end ifnottex Additional general information. @@ -3172,7 +3138,7 @@ Here is an example of a Top node. @end menu -File: texinfo.info, Node: Master Menu Parts, Prev: Top Node Example, Up: The Top Node +File: texinfo, Node: Master Menu Parts, Prev: Top Node Example, Up: The Top Node 3.6.2 Parts of a Master Menu ---------------------------- @@ -3211,7 +3177,7 @@ information.) * Overview:: Texinfo in brief. ... * Command and Variable Index:: - * Concept Index:: + * General Index:: @detailmenu --- The Detailed Node Listing --- @@ -3229,7 +3195,7 @@ information.) @end menu -File: texinfo.info, Node: Global Document Commands, Next: Software Copying Permissions, Prev: The Top Node, Up: Beginning a File +File: texinfo, Node: Global Document Commands, Next: Software Copying Permissions, Prev: The Top Node, Up: Beginning a File 3.7 Global Document Commands ============================ @@ -3247,7 +3213,7 @@ generally all given before the Top node, if they are given at all. * exampleindent:: Specify environment indentation. -File: texinfo.info, Node: documentdescription, Next: setchapternewpage, Up: Global Document Commands +File: texinfo, Node: documentdescription, Next: setchapternewpage, Up: Global Document Commands 3.7.1 `@documentdescription': Summary Text ------------------------------------------ @@ -3270,7 +3236,7 @@ This will produce the following output in the `<head>' of the HTML: document. -File: texinfo.info, Node: setchapternewpage, Next: paragraphindent, Prev: documentdescription, Up: Global Document Commands +File: texinfo, Node: setchapternewpage, Next: paragraphindent, Prev: documentdescription, Up: Global Document Commands 3.7.2 `@setchapternewpage': --------------------------- @@ -3336,7 +3302,7 @@ default option (no blank pages, same headers on all pages) use the `--texinfo' option to `texi2dvi' to specify the output you want. -File: texinfo.info, Node: paragraphindent, Next: firstparagraphindent, Prev: setchapternewpage, Up: Global Document Commands +File: texinfo, Node: paragraphindent, Next: firstparagraphindent, Prev: setchapternewpage, Up: Global Document Commands 3.7.3 `@paragraphindent': Paragraph Indenting --------------------------------------------- @@ -3375,7 +3341,7 @@ Header::. paragraphs that contain `@w' or `@*' commands. -File: texinfo.info, Node: firstparagraphindent, Next: exampleindent, Prev: paragraphindent, Up: Global Document Commands +File: texinfo, Node: firstparagraphindent, Next: exampleindent, Prev: paragraphindent, Up: Global Document Commands 3.7.4 `@firstparagraphindent': Indenting After Headings ------------------------------------------------------- @@ -3410,7 +3376,7 @@ formatting commands indent paragraphs as specified. *Note Start of Header::. -File: texinfo.info, Node: exampleindent, Prev: firstparagraphindent, Up: Global Document Commands +File: texinfo, Node: exampleindent, Prev: firstparagraphindent, Up: Global Document Commands 3.7.5 `@exampleindent': Environment Indenting --------------------------------------------- @@ -3422,7 +3388,8 @@ line followed by either `asis' or a number: @exampleindent INDENT - The indentation is according to the value of INDENT: + `@exampleindent' is ignored for HTML output. Otherwise, the +indentation is according to the value of INDENT: `asis' Do not change the existing indentation (not implemented in TeX). @@ -3435,8 +3402,9 @@ N in TeX. - The default value of INDENT is 5. `@exampleindent' is ignored for -HTML output. + The default value of INDENT is 5 spaces in Info, and 0.4in in TeX, +which is somewhat less. (The reduction is to help TeX fit more +characters onto physical lines.) It is best to write the `@exampleindent' command before the end-of-header line at the beginning of a Texinfo file, so the region @@ -3444,7 +3412,7 @@ formatting commands indent paragraphs as specified. *Note Start of Header::. -File: texinfo.info, Node: Software Copying Permissions, Prev: Global Document Commands, Up: Beginning a File +File: texinfo, Node: Software Copying Permissions, Prev: Global Document Commands, Up: Beginning a File 3.8 Software Copying Permissions ================================ @@ -3466,7 +3434,7 @@ general, an introduction would follow the licensing and distribution information, although sometimes people put it earlier in the document. -File: texinfo.info, Node: Ending a File, Next: Structuring, Prev: Beginning a File, Up: Top +File: texinfo, Node: Ending a File, Next: Structuring, Prev: Beginning a File, Up: Top 4 Ending a Texinfo File *********************** @@ -3490,7 +3458,7 @@ and the `@bye' command to mark the last line to be processed. * File End:: How to mark the end of a file. -File: texinfo.info, Node: Printing Indices & Menus, Next: File End, Up: Ending a File +File: texinfo, Node: Printing Indices & Menus, Next: File End, Up: Ending a File 4.1 Printing Indices and Menus ============================== @@ -3566,7 +3534,7 @@ index last. output; `makeinfo' generates a warning in this case. -File: texinfo.info, Node: File End, Prev: Printing Indices & Menus, Up: Ending a File +File: texinfo, Node: File End, Prev: Printing Indices & Menus, Up: Ending a File 4.2 `@bye' File Ending ====================== @@ -3583,7 +3551,7 @@ list for Emacs. *Note Using Local Variables and the Compile Command: Compile-Command, for more information. -File: texinfo.info, Node: Structuring, Next: Nodes, Prev: Ending a File, Up: Top +File: texinfo, Node: Structuring, Next: Nodes, Prev: Ending a File, Up: Top 5 Chapter Structuring ********************* @@ -3622,7 +3590,7 @@ heading at the top of each node--but you don't need to. * Raise/lower sections:: How to change commands' hierarchical level. -File: texinfo.info, Node: Tree Structuring, Next: Structuring Command Types, Up: Structuring +File: texinfo, Node: Tree Structuring, Next: Structuring Command Types, Up: Structuring 5.1 Tree Structure of Sections ============================== @@ -3655,10 +3623,10 @@ looks like this: The chapter structuring commands are described in the sections that follow; the `@node' and `@menu' commands are described in following -chapters. (*Note Nodes::, and see *Note Menus::.) +chapters. (*Note Nodes::, and see *note Menus::.) -File: texinfo.info, Node: Structuring Command Types, Next: makeinfo top, Prev: Tree Structuring, Up: Structuring +File: texinfo, Node: Structuring Command Types, Next: makeinfo top, Prev: Tree Structuring, Up: Structuring 5.2 Structuring Command Types ============================= @@ -3710,7 +3678,7 @@ In contents In contents In contents Not in contents `@subsubsection'`@unnumberedsubsubsec' `@appendixsubsubsec' `@subsubheading' -File: texinfo.info, Node: makeinfo top, Next: chapter, Prev: Structuring Command Types, Up: Structuring +File: texinfo, Node: makeinfo top, Next: chapter, Prev: Structuring Command Types, Up: Structuring 5.3 `@top' ========== @@ -3721,7 +3689,7 @@ after an `@node Top' line at the beginning of a Texinfo file. The node, so it can use it as the root of the node tree if your manual uses implicit node pointers. It has the same typesetting effect as `@unnumbered' (*note `@unnumbered' and `@appendix': unnumbered & -appendix.). For detailed information, see *Note The `@top' Command: +appendix.). For detailed information, see *note The `@top' Command: makeinfo top command. The `@top' node and its menu (if any) is conventionally wrapped in an @@ -3729,7 +3697,7 @@ makeinfo top command. output, not TeX. -File: texinfo.info, Node: chapter, Next: unnumbered & appendix, Prev: makeinfo top, Up: Structuring +File: texinfo, Node: chapter, Next: unnumbered & appendix, Prev: makeinfo top, Up: Structuring 5.4 `@chapter' ============== @@ -3758,7 +3726,7 @@ Info, the above example produces the following output: kind of stylistic choice is not usually offered by Texinfo. -File: texinfo.info, Node: unnumbered & appendix, Next: majorheading & chapheading, Prev: chapter, Up: Structuring +File: texinfo, Node: unnumbered & appendix, Next: majorheading & chapheading, Prev: chapter, Up: Structuring 5.5 `@unnumbered' and `@appendix' ================================= @@ -3766,18 +3734,14 @@ File: texinfo.info, Node: unnumbered & appendix, Next: majorheading & chaphead Use the `@unnumbered' command to create a chapter that appears in a printed manual without chapter numbers of any kind. Use the `@appendix' command to create an appendix in a printed manual that is -labelled by letter instead of by number. - - For Info file output, the `@unnumbered' and `@appendix' commands are -equivalent to `@chapter': the title is printed on a line by itself with -a line of asterisks underneath. (*Note `@chapter': chapter.) +labelled by letter (`A', `B', ...) instead of by number. - To create an appendix or an unnumbered chapter, write an `@appendix' -or `@unnumbered' command at the beginning of a line and follow it on -the same line by the title, as you would if you were creating a chapter. + Write an `@appendix' or `@unnumbered' command at the beginning of a +line and follow it on the same line by the title, as you would if you +were creating a chapter. -File: texinfo.info, Node: majorheading & chapheading, Next: section, Prev: unnumbered & appendix, Up: Structuring +File: texinfo, Node: majorheading & chapheading, Next: section, Prev: unnumbered & appendix, Up: Structuring 5.6 `@majorheading', `@chapheading' =================================== @@ -3798,44 +3762,47 @@ equivalent to `@chapter': the title is printed on a line by itself with a line of asterisks underneath. (*Note `@chapter': chapter.) -File: texinfo.info, Node: section, Next: unnumberedsec appendixsec heading, Prev: majorheading & chapheading, Up: Structuring +File: texinfo, Node: section, Next: unnumberedsec appendixsec heading, Prev: majorheading & chapheading, Up: Structuring 5.7 `@section' ============== -In a printed manual, an `@section' command identifies a numbered -section within a chapter. The section title appears in the table of -contents. In Info, an `@section' command provides a title for a -segment of text, underlined with `='. +A `@section' command identifies a section within a chapter unit, +whether created with `@chapter', `@unnumbered', or `@appendix', +following the numbering scheme of the chapter-level command. Thus, +within a `@chapter' chapter numbered `1', the section is numbered like +`1.2'; within an `@appendix' "chapter" labeled `A', the section is +numbered like `A.2'; within an `@unnumbered' chapter, the section gets +no number. - This section is headed with an `@section' command and looks like this -in the Texinfo file: + For example, this section is headed with an `@section' command and +looks like this in the Texinfo file: @section @code{@@section} To create a section, write the `@section' command at the beginning of -a line and follow it on the same line by the section title. +a line and follow it on the same line by the section title. The output +is underlined with `=' in Info. Thus, @section This is a section -produces - - This is a section - ================= +might produce the following in Info: -in Info. + 5.7 This is a section + ===================== -File: texinfo.info, Node: unnumberedsec appendixsec heading, Next: subsection, Prev: section, Up: Structuring +File: texinfo, Node: unnumberedsec appendixsec heading, Next: subsection, Prev: section, Up: Structuring 5.8 `@unnumberedsec', `@appendixsec', `@heading' ================================================ The `@unnumberedsec', `@appendixsec', and `@heading' commands are, respectively, the unnumbered, appendix-like, and heading-like -equivalents of the `@section' command. (*Note `@section': section.) +equivalents of the `@section' command, as described in the previous +section. `@unnumberedsec' The `@unnumberedsec' command may be used within an unnumbered @@ -3855,8 +3822,12 @@ equivalents of the `@section' command. (*Note `@section': section.) section-style heading that will not appear in the table of contents. + `@unnumberedsec' and `@appendixsec' do not need to be used in +ordinary circumstances, because `@section' may also be used within +`@unnumbered' and `@appendix' chapters; again, see the previous section. + -File: texinfo.info, Node: subsection, Next: unnumberedsubsec appendixsubsec subheading, Prev: unnumberedsec appendixsec heading, Up: Structuring +File: texinfo, Node: subsection, Next: unnumberedsubsec appendixsubsec subheading, Prev: unnumberedsec appendixsec heading, Up: Structuring 5.9 The `@subsection' Command ============================= @@ -3869,14 +3840,14 @@ Subsections are to sections as sections are to chapters. (*Note produces - This is a subsection - -------------------- + 1.2.3 This is a subsection + -------------------------- In a printed manual, subsections are listed in the table of contents and are numbered three levels deep. -File: texinfo.info, Node: unnumberedsubsec appendixsubsec subheading, Next: subsubsection, Prev: subsection, Up: Structuring +File: texinfo, Node: unnumberedsubsec appendixsubsec subheading, Next: subsubsection, Prev: subsection, Up: Structuring 5.10 The `@subsection'-like Commands ==================================== @@ -3895,8 +3866,13 @@ a subsection and an `@appendixsubsec' command produces a subsection-like heading labelled with a letter and numbers; both of these commands produce headings that appear in the table of contents. + `@unnumberedsubsec' and `@appendixsubsec' do not need to be used in +ordinary circumstances, because `@subsection' may also be used within +sections of `@unnumbered' and `@appendix' chapters (*note `section': +section.). + -File: texinfo.info, Node: subsubsection, Next: Raise/lower sections, Prev: unnumberedsubsec appendixsubsec subheading, Up: Structuring +File: texinfo, Node: subsubsection, Next: Raise/lower sections, Prev: unnumberedsubsec appendixsubsec subheading, Up: Structuring 5.11 The `subsub' Commands ========================== @@ -3928,17 +3904,22 @@ The fourth and lowest level sectioning commands in Texinfo are the Info, subsubheadings look exactly like ordinary subsubsection headings. + `@unnumberedsubsubsec' and `@appendixsubsubsec' do not need to be +used in ordinary circumstances, because `@subsubsection' may also be +used within subsections of `@unnumbered' and `@appendix' chapters +(*note `section': section.). + In Info, `subsub' titles are underlined with periods. For example, @subsubsection This is a subsubsection produces - This is a subsubsection - ....................... + 1.2.3.4 This is a subsubsection + ............................... -File: texinfo.info, Node: Raise/lower sections, Prev: subsubsection, Up: Structuring +File: texinfo, Node: Raise/lower sections, Prev: subsubsection, Up: Structuring 5.12 `@raisesections' and `@lowersections' ========================================== @@ -3988,7 +3969,7 @@ structure won't be correct. its own. -File: texinfo.info, Node: Nodes, Next: Menus, Prev: Structuring, Up: Top +File: texinfo, Node: Nodes, Next: Menus, Prev: Structuring, Up: Top 6 Nodes ******* @@ -4018,7 +3999,7 @@ other manuals, from mail archives, and so on. * anchor:: Defining arbitrary cross-reference targets. -File: texinfo.info, Node: Two Paths, Next: Node Menu Illustration, Up: Nodes +File: texinfo, Node: Two Paths, Next: Node Menu Illustration, Up: Nodes 6.1 Two Paths ============= @@ -4049,7 +4030,7 @@ out. Similarly, node pointers and menus are organized to create a matching structure in the Info output. -File: texinfo.info, Node: Node Menu Illustration, Next: node, Prev: Two Paths, Up: Nodes +File: texinfo, Node: Node Menu Illustration, Next: node, Prev: Two Paths, Up: Nodes 6.2 Node and Menu Illustration ============================== @@ -4116,7 +4097,7 @@ section to section (sometimes, as shown, the `Previous' pointer points up); an `Up' pointer usually leads to a node at the level above (closer to the `Top' node); and a `Menu' leads to nodes at a level below (closer to `leaves'). (A cross reference can point to a node at any level; see -*Note Cross References::.) +*note Cross References::.) Usually, an `@node' command and a chapter structuring command are used in sequence, along with indexing commands. (You may follow the @@ -4135,7 +4116,7 @@ an `@chapter' line, and then by indexing lines. @cindex File ending -File: texinfo.info, Node: node, Next: makeinfo Pointer Creation, Prev: Node Menu Illustration, Up: Nodes +File: texinfo, Node: node, Next: makeinfo Pointer Creation, Prev: Node Menu Illustration, Up: Nodes 6.3 The `@node' Command ======================= @@ -4152,33 +4133,38 @@ so a chapter or section may contain any number of nodes. Indeed, a chapter usually contains several nodes, one for each section, subsection, and subsubsection. - To create a node, write an `@node' command at the beginning of a + To specify a node, write an `@node' command at the beginning of a line, and follow it with up to four arguments, separated by commas, on the rest of the same line. The first argument is required; it is the -name of this node. The subsequent arguments are the names of the -`Next', `Previous', and `Up' pointers, in that order, and may be omitted -if your Texinfo document is hierarchically organized (*note makeinfo +name of this node (for details of node names, *note Node Line +Requirements::). The subsequent arguments are the names of the `Next', +`Previous', and `Up' pointers, in that order, and may be omitted if +your Texinfo document is hierarchically organized (*note makeinfo Pointer Creation::). - You may insert spaces before each name if you wish; the spaces are -ignored. You must write the name of the node and (if present) the names -of the `Next', `Previous', and `Up' pointers all on the same line. -Otherwise, the formatters fail. (*note info: (info)Top, for more -information about nodes in Info.) + Whether the node pointers are specified implicitly or explicitly, the +HTML output from `makeinfo' for each node includes links to the `Next', +`Previous', and `Up' nodes. The HTML also uses the `accesskey' +attribute with the values `n', `p', and `u' respectively. This allows +people using web browsers to follow the nagivation using (typically) +`M-LETTER', e.g., `M-n' for the `Next' node, from anywhere within the +node. + + You may insert spaces before each name on the `@node' line if you +wish; the spaces are ignored. You must write the name of the node and +(if present) the names of the `Next', `Previous', and `Up' pointers all +on the same line. Otherwise, the formatters fail. (*note info: +(info)Top, for more information about nodes in Info.) Usually, you write one of the chapter-structuring command lines immediately after an `@node' line--for example, an `@section' or `@subsection' line. (*Note Structuring Command Types::.) - Note: The GNU Emacs Texinfo mode updating commands work only with - Texinfo files in which `@node' lines are followed by chapter - structuring lines. *Note Updating Requirements::. - TeX uses `@node' lines to identify the names to use for cross references. For this reason, you must write `@node' lines in a Texinfo file that you intend to format for printing, even if you do not intend to format it for Info. (Cross references, such as the one at the end -of this sentence, are made with `@xref' and related commands; see *Note +of this sentence, are made with `@xref' and related commands; see *note Cross References::.) * Menu: @@ -4191,20 +4177,21 @@ Cross References::.) * makeinfo top command:: How to use the `@top' command. -File: texinfo.info, Node: Node Names, Next: Writing a Node, Up: node +File: texinfo, Node: Node Names, Next: Writing a Node, Up: node 6.3.1 Choosing Node and Pointer Names ------------------------------------- -The name of a node identifies the node. The pointers enable you to -reach other nodes and consist simply of the names of those nodes. +The name of a node identifies the node (for details of node names, +*note Node Line Requirements::). The pointers enable you to reach +other nodes and consist simply of the names of those nodes. Normally, a node's `Up' pointer contains the name of the node whose menu mentions that node. The node's `Next' pointer contains the name -of the node that follows that node in that menu and its `Previous' -pointer contains the name of the node that precedes it in that menu. -When a node's `Previous' node is the same as its `Up' node, both node -pointers name the same node. +of the node that follows the present node in that menu and its +`Previous' pointer contains the name of the node that precedes it in +that menu. When a node's `Previous' node is the same as its `Up' node, +both node pointers name the same node. Usually, the first node of a Texinfo file is the `Top' node, and its `Up' and `Previous' pointers point to the `dir' file, which contains @@ -4219,10 +4206,10 @@ first node of a Texinfo file. can write the nodes in the Texinfo source file in an arbitrary order! Because TeX processes the file sequentially, irrespective of node pointers, you must write the nodes in the order you wish them to appear -in the printed output. +in the output. -File: texinfo.info, Node: Writing a Node, Next: Node Line Tips, Prev: Node Names, Up: node +File: texinfo, Node: Writing a Node, Next: Node Line Tips, Prev: Node Names, Up: node 6.3.2 How to Write an `@node' Line ---------------------------------- @@ -4236,7 +4223,7 @@ beginning of a line and then the name of the node, like this: provided by Texinfo mode to insert the names of the pointers; or you can leave the pointers out of the Texinfo file and let `makeinfo' insert node pointers into the Info file it creates. (*Note Texinfo -Mode::, and *Note makeinfo Pointer Creation::.) +Mode::, and *note makeinfo Pointer Creation::.) Alternatively, you can insert the `Next', `Previous', and `Up' pointers yourself. If you do this, you may find it helpful to use the @@ -4251,6 +4238,12 @@ are not familiar with Texinfo. @node NODE-NAME, NEXT, PREVIOUS, UP + The NODE-NAME argument must be present, but the others are optional. +If you wish to specify some but not others, just insert commas as +needed, as in: `@node mynode,,,uppernode'. However, we recommend +leaving off all the pointers and letting `makeinfo' determine them, as +described above. + If you wish, you can ignore `@node' lines altogether in your first draft and then use the `texinfo-insert-node-lines' command to create `@node' lines for you. However, we do not recommend this practice. It @@ -4267,7 +4260,7 @@ to the node in the index. Use them all. This will make it much easier for people to find the node. -File: texinfo.info, Node: Node Line Tips, Next: Node Line Requirements, Prev: Writing a Node, Up: node +File: texinfo, Node: Node Line Tips, Next: Node Line Requirements, Prev: Writing a Node, Up: node 6.3.3 `@node' Line Tips ----------------------- @@ -4289,7 +4282,7 @@ Here are three suggestions: capitalized; others are not. -File: texinfo.info, Node: Node Line Requirements, Next: First Node, Prev: Node Line Tips, Up: node +File: texinfo, Node: Node Line Requirements, Next: First Node, Prev: Node Line Tips, Up: node 6.3.4 `@node' Line Requirements ------------------------------- @@ -4315,7 +4308,7 @@ Here are several requirements for `@node' lines: punctuation characters that are escaped with a `@', such as `@' and `{', and accent commands such as `@''. (For a few cases when this is useful, Texinfo has limited support for using @-commands in - node names; see *Note Pointer Validation::.) Perhaps this + node names; see *note Pointer Validation::.) Perhaps this limitation will be removed some day. * Unfortunately, you cannot use periods, commas, colons or @@ -4344,7 +4337,7 @@ Here are several requirements for `@node' lines: but with the internal spaces. -File: texinfo.info, Node: First Node, Next: makeinfo top command, Prev: Node Line Requirements, Up: node +File: texinfo, Node: First Node, Next: makeinfo top command, Prev: Node Line Requirements, Up: node 6.3.5 The First Node -------------------- @@ -4367,11 +4360,7 @@ Node::, for more information on the Top node contents and examples. `dir' file, which contains the main menu for the Info system as a whole. - * On the other hand, do not define the `Previous' node of the Top - node to be `(dir)', as it causes confusing behavior for users: if - you are in the Top node and hits <DEL> to go backwards, you wind - up in the middle of the some other entry in the `dir' file, which - has nothing to do with what you were reading. + * The `Prev' node of the Top node should also be your `(dir)' file. * The `Next' node of the Top node should be the first chapter in your document. @@ -4380,16 +4369,13 @@ Node::, for more information on the Top node contents and examples. *Note Installing an Info File::, for more information about installing an Info file in the `info' directory. - For concreteness, here is an example with explicit pointers (which you -can maintain automatically with the texinfo mode commands): - - Or you can leave the pointers off entirely and let the tools -implicitly define them. This is recommended. Thus: + It is usually best to leave the pointers off entirely and let the +tools implicitly define them, with this simple result: @node Top -File: texinfo.info, Node: makeinfo top command, Prev: First Node, Up: node +File: texinfo, Node: makeinfo top command, Prev: First Node, Up: node 6.3.6 The `@top' Sectioning Command ----------------------------------- @@ -4420,13 +4406,14 @@ menus. @top Your Manual Title -File: texinfo.info, Node: makeinfo Pointer Creation, Next: anchor, Prev: node, Up: Nodes +File: texinfo, Node: makeinfo Pointer Creation, Next: anchor, Prev: node, Up: Nodes 6.4 Creating Pointers with `makeinfo' ===================================== The `makeinfo' program has a feature for automatically determining node -pointers for a hierarchically organized document. +pointers for a hierarchically organized document. We highly recommend +using it. When you take advantage of this feature, you do not need to write the `Next', `Previous', and `Up' pointers after the name of a node. @@ -4442,7 +4429,12 @@ beginning with `@top' to mark the `Top' node in the file. *Note node) in a menu that is one or more hierarchical levels above the node's hierarchical level. - This implicit node pointer insertion feature in `makeinfo' relieves + If you use a detailed menu in your master menu (*note Master Menu +Parts::), mark it with the `@detailmenu @dots{} @end detailmenu' +environment, or `makeinfo' will get confused, typically about the last +and/or first node in the document. + + This implicit node pointer creation feature in `makeinfo' relieves you from the need to update menus and pointers manually or with Texinfo mode commands. (*Note Updating Nodes and Menus::.) @@ -4453,10 +4445,10 @@ sectioning commands at all (for example, if you never intend the document to be printed). The special procedure for handling the short text before a menu (*note Menus::) also disables this feature, for that group of nodes. In those cases, you will need to explicitly specify -the pointers. +all pointers. -File: texinfo.info, Node: anchor, Prev: makeinfo Pointer Creation, Up: Nodes +File: texinfo, Node: anchor, Prev: makeinfo Pointer Creation, Up: Nodes 6.5 `@anchor': Defining Arbitrary Cross-reference Targets ========================================================= @@ -4485,16 +4477,19 @@ cross-reference commands. It is best to put `@anchor' commands just before the position you wish to refer to; that way, the reader's eye is led on to the correct text when they jump to the anchor. You can put the `@anchor' command -on a line by itself if that helps readability of the source. Spaces -are always ignored after `@anchor'. +on a line by itself if that helps readability of the source. +Whitespace (including newlines) is ignored after `@anchor'. Anchor names and node names may not conflict. Anchors and nodes are given similar treatment in some ways; for example, the `goto-node' command in standalone Info takes either an anchor name or a node name as an argument. (*Note goto-node: (info-stnd)goto-node.) + Also like node names, anchor names cannot include some characters +(*note Node Line Requirements::). + -File: texinfo.info, Node: Menus, Next: Cross References, Prev: Nodes, Up: Top +File: texinfo, Node: Menus, Next: Cross References, Prev: Nodes, Up: Top 7 Menus ******* @@ -4504,11 +4499,11 @@ use menus to go to such nodes. Menus have no effect in printed manuals and do not appear in them. A node with a menu should not contain much text. If you find yourself -writing a lot of before a menu, we generally recommend moving most of -the text into a new subnode--all but a paragraph or two. Otherwise, a -reader with a terminal that displays only a few lines may miss the menu -and its associated text. As a practical matter, it is best to locate a -menu within 20 or so lines of the beginning of the node. +writing a lot of text before a menu, we generally recommend moving most +of the text into a new subnode--all but a paragraph or two. Otherwise, +a reader with a terminal that displays only a few lines may miss the +menu and its associated text. As a practical matter, it is best to +locate a menu within 20 or so lines of the beginning of the node. * Menu: @@ -4520,7 +4515,7 @@ menu within 20 or so lines of the beginning of the node. * Other Info Files:: How to refer to a different Info file. -File: texinfo.info, Node: Menu Location, Next: Writing a Menu, Up: Menus +File: texinfo, Node: Menu Location, Next: Writing a Menu, Up: Menus 7.1 Menu Location ================= @@ -4547,13 +4542,13 @@ document. Instead, use cross references to refer to arbitrary nodes. `@ifinfo' conditional instead of the normal sectioning commands after a very short node with a menu. This had the advantage of making the printed output look better, because there was no very short text -between two headings on the page. But aside from not working with -`makeinfo''s implicit pointer creation, it also makes the XML output -incorrect, since it does not reflect the true document structure. So, -unfortunately we can no longer recommend this. +between two headings on the page. But this also does not work with +`makeinfo''s implicit pointer creation, and it also makes the XML +output incorrect, since it does not reflect the true document +structure. So, regrettably, we can no longer recommend this. -File: texinfo.info, Node: Writing a Menu, Next: Menu Parts, Prev: Menu Location, Up: Menus +File: texinfo, Node: Writing a Menu, Next: Menu Parts, Prev: Menu Location, Up: Menus 7.2 Writing a Menu ================== @@ -4580,8 +4575,13 @@ above, the line `Larger Units of Text' is a menu comment line; the two lines starting with `* ' are menu entries. Space characters in a menu are preserved as-is; this allows you to format the menu as you wish. + In the HTML output from `makeinfo', the `accesskey' attribute is used +with the values `1'...`9' for the first nine entries. This allows +people using web browsers to follow the first menu entries using +(typically) `M-DIGIT', e.g., `M-1' for the first entry. + -File: texinfo.info, Node: Menu Parts, Next: Less Cluttered Menu Entry, Prev: Writing a Menu, Up: Menus +File: texinfo, Node: Menu Parts, Next: Less Cluttered Menu Entry, Prev: Writing a Menu, Up: Menus 7.3 The Parts of a Menu ======================= @@ -4613,7 +4613,7 @@ authors prefer to indent the second line while others prefer to align it with the first (and all others). It's up to you. -File: texinfo.info, Node: Less Cluttered Menu Entry, Next: Menu Example, Prev: Menu Parts, Up: Menus +File: texinfo, Node: Less Cluttered Menu Entry, Next: Menu Example, Prev: Menu Parts, Up: Menus 7.4 Less Cluttered Menu Entry ============================= @@ -4634,7 +4634,7 @@ instead of possible, since it reduces visual clutter in the menu. -File: texinfo.info, Node: Menu Example, Next: Other Info Files, Prev: Less Cluttered Menu Entry, Up: Menus +File: texinfo, Node: Menu Example, Next: Other Info Files, Prev: Less Cluttered Menu Entry, Up: Menus 7.5 A Menu Example ================== @@ -4683,7 +4683,7 @@ they must be the names of nodes in the same Info file (*note Referring to Other Info Files: Other Info Files.). -File: texinfo.info, Node: Other Info Files, Prev: Menu Example, Up: Menus +File: texinfo, Node: Other Info Files, Prev: Menu Example, Up: Menus 7.6 Referring to Other Info Files ================================= @@ -4731,7 +4731,7 @@ within the current buffer, so you cannot use them to create menus that refer to other files. You must write such menus by hand. -File: texinfo.info, Node: Cross References, Next: Marking Text, Prev: Menus, Up: Top +File: texinfo, Node: Cross References, Next: Marking Text, Prev: Menus, Up: Top 8 Cross References ****************** @@ -4753,7 +4753,7 @@ places to which cross references can refer. * uref:: How to refer to a uniform resource locator. -File: texinfo.info, Node: References, Next: Cross Reference Commands, Up: Cross References +File: texinfo, Node: References, Next: Cross Reference Commands, Up: Cross References 8.1 What References Are For =========================== @@ -4790,7 +4790,7 @@ not be used online, you must nonetheless write `@node' lines to name the places to which you make cross references. -File: texinfo.info, Node: Cross Reference Commands, Next: Cross Reference Parts, Prev: References, Up: Cross References +File: texinfo, Node: Cross Reference Commands, Next: Cross Reference Parts, Prev: References, Up: Cross References 8.2 Different Cross Reference Commands ====================================== @@ -4820,7 +4820,7 @@ for which there is no corresponding Info file and, therefore, no node to which to point. *Note `@cite': cite.) -File: texinfo.info, Node: Cross Reference Parts, Next: xref, Prev: Cross Reference Commands, Up: Cross References +File: texinfo, Node: Cross Reference Parts, Next: xref, Prev: Cross Reference Commands, Up: Cross References 8.3 Parts of a Cross Reference ============================== @@ -4868,9 +4868,11 @@ in a printed book. references within the same document. 2. The cross reference name for the Info reference, if it is to be - different from the node name. If you include this argument, it - becomes the first part of the cross reference. It is usually - omitted. + different from the node name or the topic description. If you + include this argument, it becomes the first part of the cross + reference. It is usually omitted; then the topic description + (third argument) is used if it was specified; if that was omitted + as well, the node name is used. 3. A topic description or section name. Often, this is the title of the section. This is used as the name of the reference in the @@ -4901,7 +4903,7 @@ write `@xref' at the beginning of a sentence; write `@pxref' only within parentheses, and so on. -File: texinfo.info, Node: xref, Next: Top Node Naming, Prev: Cross Reference Parts, Up: Cross References +File: texinfo, Node: xref, Next: Top Node Naming, Prev: Cross Reference Parts, Up: Cross References 8.4 `@xref' =========== @@ -4921,7 +4923,7 @@ reference, or a reference to another book or manual. * Four and Five Arguments:: `@xref' with four and five arguments. -File: texinfo.info, Node: Reference Syntax, Next: One Argument, Up: xref +File: texinfo, Node: Reference Syntax, Next: One Argument, Up: xref 8.4.1 What a Reference Looks Like and Requires ---------------------------------------------- @@ -4968,7 +4970,7 @@ cross reference that looks somewhat different. mistake them for separators. -File: texinfo.info, Node: One Argument, Next: Two Arguments, Prev: Reference Syntax, Up: xref +File: texinfo, Node: One Argument, Next: Two Arguments, Prev: Reference Syntax, Up: xref 8.4.2 `@xref' with One Argument ------------------------------- @@ -5009,7 +5011,7 @@ and comma, and then by the clause, which is followed by a period.) -File: texinfo.info, Node: Two Arguments, Next: Three Arguments, Prev: One Argument, Up: xref +File: texinfo, Node: Two Arguments, Next: Three Arguments, Prev: One Argument, Up: xref 8.4.3 `@xref' with Two Arguments -------------------------------- @@ -5053,7 +5055,7 @@ and comma, and then by the clause, which is followed by a period.) -File: texinfo.info, Node: Three Arguments, Next: Four and Five Arguments, Prev: Two Arguments, Up: xref +File: texinfo, Node: Three Arguments, Next: Four and Five Arguments, Prev: Two Arguments, Up: xref 8.4.4 `@xref' with Three Arguments ---------------------------------- @@ -5123,7 +5125,7 @@ are different. @xref{Regexp, , Regular Expressions as Patterns}. -File: texinfo.info, Node: Four and Five Arguments, Prev: Three Arguments, Up: xref +File: texinfo, Node: Four and Five Arguments, Prev: Three Arguments, Up: xref 8.4.5 `@xref' with Four and Five Arguments ------------------------------------------ @@ -5201,7 +5203,7 @@ this case, you need to specify only the fourth argument, and not the fifth. -File: texinfo.info, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross References +File: texinfo, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross References 8.5 Naming a `Top' Node ======================= @@ -5209,7 +5211,7 @@ File: texinfo.info, Node: Top Node Naming, Next: ref, Prev: xref, Up: Cross In a cross reference, you must always name a node. This means that in order to refer to a whole manual, you must identify the `Top' node by writing it as the first argument to the `@xref' command. (This is -different from the way you write a menu entry; see *Note Referring to +different from the way you write a menu entry; see *note Referring to Other Info Files: Other Info Files.) At the same time, to provide a meaningful section topic or title in the printed cross reference (instead of the word `Top'), you must write an appropriate entry for @@ -5231,7 +5233,7 @@ In this example, `Top' is the name of the first node, and `Overview' is the name of the first section of the manual. -File: texinfo.info, Node: ref, Next: pxref, Prev: Top Node Naming, Up: Cross References +File: texinfo, Node: ref, Next: pxref, Prev: Top Node Naming, Up: Cross References 8.6 `@ref' ========== @@ -5242,15 +5244,16 @@ useful as the last part of a sentence. For example, - For more information, see @ref{Hurricanes}. + For more information, @pxref{This}, and @ref{That}. -produces (in Info): +produces in Info: - For more information, see *Note Hurricanes::. + For more information, *note This::, and *note That::. -and (in printed output): +and in printed output: - For more information, see Section 8.2 [Hurricanes], page 123. + For more information, see Section 1.1 [This], page 1, and Section + 1.2 [That], page 2. The `@ref' command sometimes tempts writers to express themselves in a manner that is suitable for a printed manual but looks awkward in the @@ -5263,50 +5266,44 @@ looks ok in the printed output: Sea surges are described in Section 6.7 [Hurricanes], page 72. -but is awkward to read in Info: +but is awkward to read in Info, "note" being a verb: - Sea surges are described in *Note Hurricanes::. + Sea surges are described in *note Hurricanes::. - Caution: You should write a period or comma immediately after an - `@ref' command with two or more arguments. Otherwise, Info will - generate a (grammatically incorrect) period, just so the - cross-reference doesn't fail completely. + You should write a period or comma immediately after an `@ref' +command with two or more arguments. If there is no such following +punctuation, `makeinfo' will generate a (grammatically incorrect) +period in the Info output; otherwise, the cross-reference would fail +completely, due to the current syntax of Info format. - As a general rule, you should write a period or comma after every -`@ref' command. This works best in both the printed and the Info -output. + In general, it is best to use `@ref' only when you need some word +other than "see" to precede the reference. When "see" (or "See") is +ok, `@xref' and `@pxref' are preferable. -File: texinfo.info, Node: pxref, Next: inforef, Prev: ref, Up: Cross References +File: texinfo, Node: pxref, Next: inforef, Prev: ref, Up: Cross References 8.7 `@pxref' ============ The parenthetical reference command, `@pxref', is nearly the same as -`@xref', but you use it _only_ inside parentheses and you do _not_ type -a comma or period after the command's closing brace. The command -differs from `@xref' in two ways: +`@xref', but it is best used at the end of a sentence or before a +closing parenthesis. The command differs from `@xref' in two ways: 1. TeX typesets the reference for the printed manual with a lower case `see' rather than an upper case `See'. 2. The Info formatting commands automatically end the reference with a - closing colon or period. - - Because one type of formatting automatically inserts closing -punctuation and the other does not, you should use `@pxref' _only_ -inside parentheses as part of another sentence. Also, you yourself -should not insert punctuation after the reference, as you do with -`@xref'. + closing colon or period, if necessary. `@pxref' is designed so that the output looks right and works right -between parentheses both in printed output and in an Info file. In a -printed manual, a closing comma or period should not follow a cross -reference within parentheses; such punctuation is wrong. But in an -Info file, suitable closing punctuation must follow the cross reference -so Info can recognize its end. `@pxref' spares you the need to use -complicated methods to put a terminator into one form of the output and -not the other. +at the end of a sentence or parenthetical phrase, both in printed +output and in an Info file. In a printed manual, a closing comma or +period should not follow a cross reference within parentheses; such +punctuation is wrong. But in an Info file, suitable closing +punctuation must follow the cross reference so Info can recognize its +end. `@pxref' spares you the need to use complicated methods to put a +terminator into one form of the output and not the other. With one argument, a parenthetical cross reference looks like this: @@ -5314,7 +5311,7 @@ With one argument, a parenthetical cross reference looks like this: which produces - ... storms cause flooding (*Note Hurricanes::) ... + ... storms cause flooding (*note Hurricanes::) ... and @@ -5327,32 +5324,47 @@ and which produces - ... (*Note CROSS-REFERENCE-NAME: NODE-NAME.) ... + ... (*note CROSS-REFERENCE-NAME: NODE-NAME.) ... and ... (see Section NNN [NODE-NAME], page PPP) ... - `@pxref' can be used with up to five arguments just like `@xref' + `@pxref' can be used with up to five arguments, just like `@xref' (*note `@xref': xref.). - Caution: Use `@pxref' only as a parenthetical reference. Do not - try to use `@pxref' as a clause in a sentence. It will look bad - in either the Info file, the printed output, or both. + In past versions of Texinfo, it was not allowed to write punctuation +after a `@pxref', so it could be used _only_ before a right +parenthesis. This is no longer the case, so now it can be used (for +example) at the end of a sentence, where a lowercase "see" works best. +For instance: + + ... For more information, @pxref{More}. - Parenthetical cross references look best at the ends of sentences. -Although they technically work in the middle of a sentence, that -location breaks up the flow of reading. +which outputs (in Info): + + ... For more information, *note More::. + +This works fine. `@pxref' should only be followed by a comma, period, +or right parenthesis; in other cases, `makeinfo' has to insert a period +to make the cross-reference work correctly in Info, and that period +looks wrong. + + As a matter of general style, `@pxref' is best used at the ends of +sentences. Although it technically works in the middle of a sentence, +that location breaks up the flow of reading. -File: texinfo.info, Node: inforef, Next: uref, Prev: pxref, Up: Cross References +File: texinfo, Node: inforef, Next: uref, Prev: pxref, Up: Cross References 8.8 `@inforef' ============== -`@inforef' is used for cross references to Info files for which there -are no printed manuals. Even in a printed manual, `@inforef' generates -a reference directing the user to look in an Info file. +`@inforef' is used for making cross references to Info documents--even +from a printed manual. This might be because you want to refer to +conditional `@ifinfo' text (*note Conditionals::), or because printed +output is not available (perhaps because there is no Texinfo source), +among other possibilities. The command takes either two or three arguments, in the following order: @@ -5371,37 +5383,28 @@ The template is: @inforef{NODE-NAME, CROSS-REFERENCE-NAME, INFO-FILE-NAME}, -Thus, +For example, @inforef{Advanced, Advanced Info commands, info}, for more information. -produces +produces (in Info): *Note Advanced Info commands: (info)Advanced, for more information. -and +and (in the printed output): See Info file `info', node `Advanced', for more information. -Similarly, - - @inforef{Advanced, , info}, for more information. - -produces - - *Note (info)Advanced::, for more information. - -and - - See Info file `info', node `Advanced', for more information. + (This particular example is not realistic, since the Info manual is +written in Texinfo, so all formats are available.) The converse of `@inforef' is `@cite', which is used to refer to printed works for which no Info form exists. *Note `@cite': cite. -File: texinfo.info, Node: uref, Prev: inforef, Up: Cross References +File: texinfo, Node: uref, Prev: inforef, Up: Cross References 8.9 `@url', `@uref{URL[, TEXT][, REPLACEMENT]}' =============================================== @@ -5414,7 +5417,7 @@ link you can follow. `@url' is a synonym for `@uref'. Originally, `@url' had the meaning of `@indicateurl' (*note `@indicateurl': indicateurl.), but in actual practice it was misused the vast majority of the time. So we've -changed the definitions. +changed the meaning. The second argument, if specified, is the text to display (the default is the url itself); in Info and DVI output, but not in HTML output, the @@ -5456,13 +5459,13 @@ and the HTML output is this: holds programs and texts. An example of the three-argument form: - The @uref{/man.cgi/1/ls,,ls(1)} program ... + The @uref{/man.cgi/1/ls,,ls} program ... produces: - The ls(1) program ... + The ls program ... but with HTML: - The <a href="/man.cgi/1/ls">ls(1)</a> program ... + The <a href="/man.cgi/1/ls">ls</a> program ... To merely indicate a url without creating a link people can follow, use `@indicateurl' (*note `@indicateurl': indicateurl.). @@ -5477,7 +5480,7 @@ software that tries to detect url's in text already has to detect them without the `<URL:' to be useful. -File: texinfo.info, Node: Marking Text, Next: Quotations and Examples, Prev: Cross References, Up: Top +File: texinfo, Node: Marking Text, Next: Quotations and Examples, Prev: Cross References, Up: Top 9 Marking Words and Phrases *************************** @@ -5494,7 +5497,7 @@ program. Also, you can emphasize text, in several different ways. * Emphasis:: How to emphasize text. -File: texinfo.info, Node: Indicating, Next: Emphasis, Up: Marking Text +File: texinfo, Node: Indicating, Next: Emphasis, Up: Marking Text 9.1 Indicating Definitions, Commands, etc. ========================================== @@ -5522,21 +5525,22 @@ not something else that should not be changed. * code:: Indicating program code. * kbd:: Showing keyboard input. * key:: Specifying keys. -* samp:: A literal sequence of characters. -* verb:: A verbatim sequence of characters. +* samp:: Indicating a literal sequence of characters. +* verb:: Indicating a verbatim sequence of characters. * var:: Indicating metasyntactic variables. * env:: Indicating environment variables. * file:: Indicating file names. * command:: Indicating command names. * option:: Indicating option names. * dfn:: Specifying definitions. -* cite:: Referring to books not in the Info system. +* cite:: Referring to books not in the Info system. +* abbr:: Indicating abbreviations. * acronym:: Indicating acronyms. -* indicateurl:: Indicating a World Wide Web reference. +* indicateurl:: Indicating an example URL. * email:: Indicating an electronic mail address. -File: texinfo.info, Node: Useful Highlighting, Next: code, Up: Indicating +File: texinfo, Node: Useful Highlighting, Next: code, Up: Indicating 9.1.1 Highlighting Commands are Useful -------------------------------------- @@ -5552,50 +5556,61 @@ construct an index of functions if you had not already made the entries. `@code{SAMPLE-CODE}' Indicate text that is a literal example of a piece of a program. + *Note `@code': code. `@kbd{KEYBOARD-CHARACTERS}' - Indicate keyboard input. + Indicate keyboard input. *Note `@kbd': kbd. `@key{KEY-NAME}' - Indicate the conventional name for a key on a keyboard. + Indicate the conventional name for a key on a keyboard. *Note + `@key': key. `@samp{TEXT}' Indicate text that is a literal example of a sequence of - characters. + characters. *Note `@samp': samp. + +`@verb{TEXT}' + Write a verbatim sequence of characters. *Note `@verb': verb. `@var{METASYNTACTIC-VARIABLE}' - Indicate a metasyntactic variable. + Indicate a metasyntactic variable. *Note `@var': var. `@env{ENVIRONMENT-VARIABLE}' - Indicate an environment variable. + Indicate an environment variable. *Note `@env': env. `@file{FILE-NAME}' - Indicate the name of a file. + Indicate the name of a file. *Note `@file': file. `@command{COMMAND-NAME}' - Indicate the name of a command. + Indicate the name of a command. *Note `@command': command. `@option{OPTION}' - Indicate a command-line option. + Indicate a command-line option. *Note `@option': option. `@dfn{TERM}' - Indicate the introductory or defining use of a term. + Indicate the introductory or defining use of a term. *Note + `@dfn': dfn. `@cite{REFERENCE}' - Indicate the name of a book. + Indicate the name of a book. *Note `@cite': cite. + +`@abbr{ABBREVIATION}' + Indicate an abbreviation. `@acronym{ACRONYM}' - Indicate an acronym. + Indicate an acronym. *Note `@acronym': acronym. `@indicateurl{UNIFORM-RESOURCE-LOCATOR}' - Indicate a uniform resource locator for the World Wide Web. + Indicate an example (that is, nonfunctional) uniform resource + locator. *Note `@indicateurl': indicateurl. (Use `@url' (*note + `@url': uref.) for live url's.) `@email{EMAIL-ADDRESS[, DISPLAYED-TEXT]}' - Indicate an electronic mail address. + Indicate an electronic mail address. *Note `@email': email. -File: texinfo.info, Node: code, Next: kbd, Prev: Useful Highlighting, Up: Indicating +File: texinfo, Node: code, Next: kbd, Prev: Useful Highlighting, Up: Indicating 9.1.2 `@code'{SAMPLE-CODE} -------------------------- @@ -5625,17 +5640,15 @@ sentence. In the printed manual, `@code' causes TeX to typeset the argument in a typewriter face. In the Info file, it causes the Info formatting -commands to use single quotation marks around the text. - - For example, +commands to use single quotation marks around the text. For example, The function returns @code{nil}. -produces this in the printed manual: +produces this: The function returns `nil'. - Here are some cases for which it is preferable not to use `@code': + Here are some cases for which it is preferable _not_ to use `@code': * For shell command names such as `ls' (use `@command'). @@ -5670,8 +5683,12 @@ options, and environment variables. The new commands allow you to express the markup more precisely, but there is no real harm in using the older commands, and of course the long-standing manuals do so. + Ordinarily, TeX will consider breaking lines at `-' and `_' +characters within `@code' and related commands. This can be controlled +with `@allowcodebreaks' (*note `@allowcodebreaks': allowcodebreaks.). + -File: texinfo.info, Node: kbd, Next: key, Prev: code, Up: Indicating +File: texinfo, Node: kbd, Next: key, Prev: code, Up: Indicating 9.1.3 `@kbd'{KEYBOARD-CHARACTERS} --------------------------------- @@ -5738,7 +5755,7 @@ explicitly want to mention a space character as one of the characters of input, write `@key{SPC}' for it.) -File: texinfo.info, Node: key, Next: samp, Prev: kbd, Up: Indicating +File: texinfo, Node: key, Next: samp, Prev: kbd, Up: Indicating 9.1.4 `@key'{KEY-NAME} ---------------------- @@ -5752,9 +5769,10 @@ keyboard, as in: command when the sequence of characters to be typed includes one or more keys that are described by name. - For example, to produce `C-x <ESC>' you would type: + For example, to produce `C-x <ESC>' and `M-<TAB>' you would type: @kbd{C-x @key{ESC}} + @kbd{M-@key{TAB}} Here is a list of the recommended names for keys: @@ -5767,7 +5785,7 @@ more keys that are described by name. LFD Linefeed (however, since most keyboards nowadays do not have a Linefeed key, it might be better to call this character - `C-j'. + `C-j') TAB Tab @@ -5778,7 +5796,7 @@ more keys that are described by name. ESC Escape - DEL + DELETE Delete SHIFT @@ -5797,8 +5815,11 @@ do not use the `@key' command; but when you are referring to the modifier key in isolation, use the `@key' command. For example, write `@kbd{Meta-a}' to produce `Meta-a' and `@key{META}' to produce <META>. + As a convention in GNU manuals, `@key' should not be used in index +entries. + -File: texinfo.info, Node: samp, Next: verb, Prev: key, Up: Indicating +File: texinfo, Node: samp, Next: verb, Prev: key, Up: Indicating 9.1.5 `@samp'{TEXT} ------------------- @@ -5838,7 +5859,7 @@ This produces: `y'. -File: texinfo.info, Node: verb, Next: var, Prev: samp, Up: Indicating +File: texinfo, Node: verb, Next: var, Prev: samp, Up: Indicating 9.1.6 `@verb'{<char>TEXT<char>} ------------------------------- @@ -5863,9 +5884,11 @@ text, where the three characters `@{}' are special. With `@verb', nothing is special except the delimiter character you choose. It is not reliable to use `@verb' inside other Texinfo constructs. +In particular, it does not work to use `@verb' in anything related to +cross-referencing, such as section titles or figure captions. -File: texinfo.info, Node: var, Next: env, Prev: verb, Up: Indicating +File: texinfo, Node: var, Next: env, Prev: verb, Up: Indicating 9.1.7 `@var'{METASYNTACTIC-VARIABLE} ------------------------------------ @@ -5924,7 +5947,7 @@ modify the sources to `texinfo.tex' and the Info formatting commands to output the `<...>' format if you wish.) -File: texinfo.info, Node: env, Next: file, Prev: var, Up: Indicating +File: texinfo, Node: env, Next: file, Prev: var, Up: Indicating 9.1.8 `@env'{ENVIRONMENT-VARIABLE} ---------------------------------- @@ -5941,7 +5964,7 @@ variables; use `@var' instead (see the previous section). The `PATH' environment variable ... -File: texinfo.info, Node: file, Next: command, Prev: env, Up: Indicating +File: texinfo, Node: file, Next: command, Prev: env, Up: Indicating 9.1.9 `@file'{FILE-NAME} ------------------------ @@ -5962,7 +5985,7 @@ produces The `.el' files are in the `/usr/local/emacs/lisp' directory. -File: texinfo.info, Node: command, Next: option, Prev: file, Up: Indicating +File: texinfo, Node: command, Next: option, Prev: file, Up: Indicating 9.1.10 `@command'{COMMAND-NAME} ------------------------------- @@ -5985,7 +6008,7 @@ such as `Emacs' or `Bison'. should use either `@samp' or `@code' at your discretion. -File: texinfo.info, Node: option, Next: dfn, Prev: command, Up: Indicating +File: texinfo, Node: option, Next: dfn, Prev: command, Up: Indicating 9.1.11 `@option'{OPTION-NAME} ----------------------------- @@ -6004,7 +6027,7 @@ example, `-l' or `--version' or `--output=FILENAME'. effect. -File: texinfo.info, Node: dfn, Next: cite, Prev: option, Up: Indicating +File: texinfo, Node: dfn, Next: cite, Prev: option, Up: Indicating 9.1.12 `@dfn'{TERM} ------------------- @@ -6028,7 +6051,7 @@ say explicitly that it is a definition, but it should contain the information of a definition--it should make the meaning clear. -File: texinfo.info, Node: cite, Next: acronym, Prev: dfn, Up: Indicating +File: texinfo, Node: cite, Next: abbr, Prev: dfn, Up: Indicating 9.1.13 `@cite'{REFERENCE} ------------------------- @@ -6042,28 +6065,68 @@ command since a reader can easily follow such a reference in Info. *Note `@xref': xref. -File: texinfo.info, Node: acronym, Next: indicateurl, Prev: cite, Up: Indicating +File: texinfo, Node: abbr, Next: acronym, Prev: cite, Up: Indicating -9.1.14 `@acronym'{ACRONYM[, MEANING]} +9.1.14 `@abbr'{ABBREVIATION[, MEANING]} +--------------------------------------- + +You can use the `@abbr' command for general abbreviations. The +abbreviation is given as the single argument in braces, as in +`@abbr{Comput.}'. As a matter of style, or for particular +abbreviations, you may prefer to omit periods, as in `@abbr{Mr} +Stallman'. + + `@abbr' accepts an optional second argument, intended to be used for +the meaning of the abbreviation. + + If the abbreviation ends with a lowercase letter and a period, and is +not at the end of a sentence, and has no second argument, remember to +use the `@.' command (*note Not Ending a Sentence::) to get the correct +spacing. However, you do not have to use `@.' within the abbreviation +itself; Texinfo automatically assumes periods within the abbreviation +do not end a sentence. + + In TeX and in the Info output, the first argument is printed as-is; +if the second argument is present, it is printed in parentheses after +the abbreviation. In HTML and XML, the `<abbr>' tag is used; in +Docbook, the `<abbrev>' tag is used. For instance: + + @abbr{Comput. J., Computer Journal} + +produces: + + Comput. J. (Computer Journal) + + For abbreviations consisting of all capital letters, you may prefer to +use the `@acronym' command instead. See the next section for more on +the usage of these two commands. + + +File: texinfo, Node: acronym, Next: indicateurl, Prev: abbr, Up: Indicating + +9.1.15 `@acronym'{ACRONYM[, MEANING]} ------------------------------------- Use the `@acronym' command for abbreviations written in all capital letters, such as `NASA'. The abbreviation is given as the single argument in braces, as in `@acronym{NASA}'. As a matter of style, or -for particular abbreviations, you may prefer to use periods, as in -`@acronym{F.B.I.}'. +for particular acronyms, you may prefer to use periods, as in +`@acronym{N.A.S.A.}'. + + `@acronym' accepts an optional second argument, intended to be used +for the meaning of the acronym. - If the acronym is at the end of a sentence, remember to use the -special `@.' and similar commands (*note Ending a Sentence::). + If the acronym is at the end of a sentence, and if there is no second +argument, remember to use the `@.' or similar command (*note Ending a +Sentence::) to get the correct spacing. In TeX, the acronym is printed in slightly smaller font. In the Info -output, the argument is printed as-is. In HTML, Docbook, and XML, the -`<acronym>' tag is used. +output, the argument is printed as-is. In either format, if the second +argument is present, it is printed in parentheses after the acronym. +In HTML, Docbook, and XML, the `<acronym>' tag is used. - `@acronym' accepts an optional second argument, intended to be used -for the meaning of the acronym. If present, it is printed in -parentheses after the acronym. For instance (since GNU is a recursive -acronym, we use `@acronym' recursively): + For instance (since GNU is a recursive acronym, we use `@acronym' +recursively): @acronym{GNU, @acronym{GNU}'s Not Unix} @@ -6075,10 +6138,34 @@ produces: capitals. Don't use `@acronym' for this, since a name is not an acronym. Use `@sc' instead (*note Smallcaps::). + `@abbr' and `@acronym' are closely related commands: they both signal +to the reader that a shortened form is being used, and possibly give a +meaning. When choosing whether to use these two commands, please bear +the following in mind. + + - In standard English usage, acronyms are a subset of abbreviations: + they include pronounceable words like `NATO', `radar', and + `snafu', and some sources also include syllable acronyms like + `Usenet', hybrids like `SIGGRAPH', and unpronounceable initialisms + like `FBI'. + + - In Texinfo, an acronym (but not an abbreviation) should consist + only of capital letters and periods, no lowercase. + + - In TeX, an acronym (but not an abbreviation) is printed in a + slightly smaller font. + + - Some browsers place a dotted bottom border under abbreviations but + not acronyms. + + - It's not essential to use these commands for all abbreviations. + Text is perfectly readable without them. + + -File: texinfo.info, Node: indicateurl, Next: email, Prev: acronym, Up: Indicating +File: texinfo, Node: indicateurl, Next: email, Prev: acronym, Up: Indicating -9.1.15 `@indicateurl'{UNIFORM-RESOURCE-LOCATOR} +9.1.16 `@indicateurl'{UNIFORM-RESOURCE-LOCATOR} ----------------------------------------------- Use the `@indicateurl' command to indicate a uniform resource locator @@ -6095,9 +6182,9 @@ which produces: For example, the url might be <http://example.org/path>. -File: texinfo.info, Node: email, Prev: indicateurl, Up: Indicating +File: texinfo, Node: email, Prev: indicateurl, Up: Indicating -9.1.16 `@email'{EMAIL-ADDRESS[, DISPLAYED-TEXT]} +9.1.17 `@email'{EMAIL-ADDRESS[, DISPLAYED-TEXT]} ------------------------------------------------ Use the `@email' command to indicate an electronic mail address. It @@ -6116,7 +6203,7 @@ composition window. For example: suggestions to the same place <bug-texinfo@gnu.org>. -File: texinfo.info, Node: Emphasis, Prev: Indicating, Up: Marking Text +File: texinfo, Node: Emphasis, Prev: Indicating, Up: Marking Text 9.2 Emphasizing Text ==================== @@ -6137,7 +6224,7 @@ regular use. * Fonts:: Various font commands for printed output. -File: texinfo.info, Node: emph & strong, Next: Smallcaps, Up: Emphasis +File: texinfo, Node: emph & strong, Next: Smallcaps, Up: Emphasis 9.2.1 `@emph'{TEXT} and `@strong'{TEXT} --------------------------------------- @@ -6174,7 +6261,7 @@ preceding example. `@quotation'--`Note' is allowable there. -File: texinfo.info, Node: Smallcaps, Next: Fonts, Prev: emph & strong, Up: Emphasis +File: texinfo, Node: Smallcaps, Next: Fonts, Prev: emph & strong, Up: Emphasis 9.2.2 `@sc'{TEXT}: The Small Caps Font -------------------------------------- @@ -6189,7 +6276,7 @@ This produces: Richard STALLMAN founded GNU. - As shown here, we recommend using `@acronym' for actual abbreviations + As shown here, we recommend using `@acronym' for actual acronyms (*note acronym::), and reserving `@sc' for special cases where you want small caps. The output is not the same (`@acronym' prints in a smaller text font, not the small caps font), but more importantly it describes @@ -6210,30 +6297,58 @@ output marked with the `<small>' tag to reduce the font size. We recommend using regular mixed case wherever possible. -File: texinfo.info, Node: Fonts, Prev: Smallcaps, Up: Emphasis +File: texinfo, Node: Fonts, Prev: Smallcaps, Up: Emphasis 9.2.3 Fonts for Printing, Not Info ---------------------------------- -Texinfo provides four font commands that specify font changes in the -printed manual and (where possible) in the HTML output, but have no -effect in the Info file. All four commands apply to an argument that -follows, surrounded by braces. +Texinfo provides one command to change the size of the main body font +in the TeX output for a document: `@fonttextsize'. It has no effect at +all in other output. It takes a single argument on the remainder of +the line, which must be either `10' or `11'. For example: -`@i' - selects an italic font; + @fonttextsize 10 + + The effect is to reduce the body font to a 10pt size (the default is +11pt). Fonts for other elements, such as sections and chapters, are +reduced accordingly. This should only be used in conjunction with +`@smallbook' (*note Printing "Small" Books: smallbook.) or similar, +since 10pt fonts on standard paper (8.5x11 or A4) are too small. One +reason to use this command is to save pages, and hence printing cost, +for physical books. + + Texinfo does not at present have commands to switch the font family +to use, or more general size-changing commands. + + Texinfo also provides a number of font commands that specify font +changes in the printed manual and (where possible) in the HTML output, +but have no effect in the Info file. All the commands apply to an +argument that follows, surrounded by braces. `@b' selects bold face; -`@t' - selects the fixed-width, typewriter-style font used by `@code'; +`@i' + selects an italic font; `@r' selects a roman font, which is the usual font in which text is - printed. + printed. It may or may not be seriffed. + +`@sansserif' + selects a sans serif font; + +`@slanted' + selects a slanted font; + +`@t' + selects the fixed-width, typewriter-style font used by `@code'; + (The commands with longer names were invented much later than the +others, at which time it did not seem desirable to use very short names +for such an infrequently needed feature.) + Only the `@r' command has much use: in example-like environments, you can use the `@r' command to write comments in the standard roman font instead of the fixed-width font. This looks better in printed output, @@ -6249,26 +6364,27 @@ produces (+ 2 2) ; Add two plus two. - In general, you should avoid using the other three font commands. If -you need to use one, it probably indicates a gap in the Texinfo -language. + In general, you should avoid using the other font commands. Some of +them are only useful when documenting functionality of specific font +effects, such as in TeX and related packages. -File: texinfo.info, Node: Quotations and Examples, Next: Lists and Tables, Prev: Marking Text, Up: Top +File: texinfo, Node: Quotations and Examples, Next: Lists and Tables, Prev: Marking Text, Up: Top 10 Quotations and Examples ************************** Quotations and examples are blocks of text consisting of one or more whole paragraphs that are set off from the bulk of the text and treated -differently. They are usually indented. +differently. They are usually indented in the output. In Texinfo, you always begin a quotation or example by writing an @-command at the beginning of a line by itself, and end it by writing an `@end' command that is also at the beginning of a line by itself. For instance, you begin an example by writing `@example' by itself at the beginning of a line and end the example by writing `@end example' -on a line by itself, at the beginning of that line. +on a line by itself, at the beginning of that line, and with only one +space between the `@end' and the `example'. * Menu: @@ -6288,7 +6404,7 @@ on a line by itself, at the beginning of that line. * cartouche:: Drawing rounded rectangles around examples. -File: texinfo.info, Node: Block Enclosing Commands, Next: quotation, Up: Quotations and Examples +File: texinfo, Node: Block Enclosing Commands, Next: quotation, Up: Quotations and Examples 10.1 Block Enclosing Commands ============================= @@ -6351,7 +6467,7 @@ rounded corners around it. *Note Drawing Cartouches Around Examples: cartouche. -File: texinfo.info, Node: quotation, Next: example, Prev: Block Enclosing Commands, Up: Quotations and Examples +File: texinfo, Node: quotation, Next: example, Prev: Block Enclosing Commands, Up: Quotations and Examples 10.2 `@quotation': Block quotations =================================== @@ -6362,10 +6478,9 @@ filled) except that: * the margins are closer to the center of the page, so the whole of the quotation is indented; - * the first lines of paragraphs are indented no more than other - lines; + * and the first lines of paragraphs are indented no more than other + lines. - * in the printed output, interparagraph spacing is reduced. This is an example of text written between an `@quotation' command and an `@end quotation' command. An `@quotation' command is most @@ -6400,7 +6515,7 @@ etc.) instead of the default `<blockquote>'. HTML output always uses `<blockquote>'. -File: texinfo.info, Node: example, Next: verbatim, Prev: quotation, Up: Quotations and Examples +File: texinfo, Node: example, Next: verbatim, Prev: quotation, Up: Quotations and Examples 10.3 `@example': Example Text ============================= @@ -6464,7 +6579,7 @@ displaying them, use the `@code' command or its relatives (*note normal roman font, you can use the `@r' command (*note Fonts::). -File: texinfo.info, Node: verbatim, Next: verbatiminclude, Prev: example, Up: Quotations and Examples +File: texinfo, Node: verbatim, Next: verbatiminclude, Prev: example, Up: Quotations and Examples 10.4 `@verbatim': Literal Text ============================== @@ -6473,18 +6588,12 @@ Use the `@verbatim' environment for printing of text that may contain special characters or commands that should not be interpreted, such as computer input or output (`@example' interprets its text as regular Texinfo commands). This is especially useful for including -automatically generated output in a Texinfo manual. Here is an example; -the output you see is just the same as the input, with a line -`@verbatim' before and a line `@end verbatim' after. - +automatically generated files in a Texinfo manual. -This is an example of text written in a @verbatim -block. No character substitutions are made. All commands -are ignored, until `<at>end verbatim'. - -In the printed manual, the text is typeset in a -fixed-width font, and not indented or filled. All -spaces and blank lines are significant, including tabs. + In general, the output will be just the same as the input. No +character substitutions are made, e.g., all spaces and blank lines are +significant, including tabs. In the printed manual, the text is +typeset in a fixed-width font, and not indented or filled. Write a `@verbatim' command at the beginning of a line by itself. This line will disappear from the output. Mark the end of the verbatim @@ -6502,8 +6611,7 @@ expand<TAB>me @end verbatim -produces - +This produces: { @command with strange characters: @'e @@ -6516,10 +6624,21 @@ and another blank line after the `@end verbatim'. Blank lines between the beginning `@verbatim' and the ending `@end verbatim' will appear in the output. - It is not reliable to use `@verbatim' inside other Texinfo constructs. + You can get a "small" verbatim by enclosing the `@verbatim' in an +`@smallformat' environment, as shown here: + +@smallformat +@verbatim +... still verbatim, but in a smaller font ... +@end verbatim +@end smallformat + + + Finally, a word of warning: it is not reliable to use `@verbatim' +inside other Texinfo constructs. -File: texinfo.info, Node: verbatiminclude, Next: lisp, Prev: verbatim, Up: Quotations and Examples +File: texinfo, Node: verbatiminclude, Next: lisp, Prev: verbatim, Up: Quotations and Examples 10.5 `@verbatiminclude' FILE: Include a File Verbatim ===================================================== @@ -6537,15 +6656,17 @@ indentation is added; if you want indentation, enclose the The name of the file is taken literally, with a single exception: `@value{VAR}' references are expanded. This makes it possible to -reliably include files in other directories in a distribution, for -instance: +include files in other directories within a distribution, for instance: - @include @value{top_srcdir}/NEWS + @verbatiminclude @value{top_srcdir}/NEWS (You still have to get `top_srcdir' defined in the first place.) + For a method on printing the file contents in a smaller font size, see +the end of the previous section on `@verbatim'. + -File: texinfo.info, Node: lisp, Next: small, Prev: verbatiminclude, Up: Quotations and Examples +File: texinfo, Node: lisp, Next: small, Prev: verbatiminclude, Up: Quotations and Examples 10.6 `@lisp': Marking a Lisp Example ==================================== @@ -6569,7 +6690,7 @@ Then you can use the Texinfo file as a Lisp library.(1) similar fashion for C, Fortran, or other languages. -File: texinfo.info, Node: small, Next: display, Prev: lisp, Up: Quotations and Examples +File: texinfo, Node: small, Next: display, Prev: lisp, Up: Quotations and Examples 10.7 `@small...' Block Commands =============================== @@ -6606,16 +6727,17 @@ only one of (for instance) `@example' or `@smallexample' consistently within a chapter. -File: texinfo.info, Node: display, Next: format, Prev: small, Up: Quotations and Examples +File: texinfo, Node: display, Next: format, Prev: small, Up: Quotations and Examples 10.8 `@display' and `@smalldisplay' =================================== -The `@display' command begins a kind of example. It is like the -`@example' command except that, in a printed manual, `@display' does -not select the fixed-width font. In fact, it does not specify the font -at all, so that the text appears in the same font it would have -appeared in without the `@display' command. +The `@display' command begins a kind of example, where each line of +input produces a line of output, and the output is indented. It is +thus like the `@example' command except that, in a printed manual, +`@display' does not select the fixed-width font. In fact, it does not +specify the font at all, so that the text appears in the same font it +would have appeared in without the `@display' command. This is an example of text written between an `@display' command and an `@end display' command. The `@display' command @@ -6625,8 +6747,13 @@ appeared in without the `@display' command. `@display' but uses a smaller font in `@smallbook' format. *Note small::. + The `@table' command (*note table::) does not work inside `@display'. +Since `@display' is line-oriented, it doesn't make sense to use them +together. If you want to indent a table, try `@quotation' (*note +quotation::). + -File: texinfo.info, Node: format, Next: exdent, Prev: display, Up: Quotations and Examples +File: texinfo, Node: format, Next: exdent, Prev: display, Up: Quotations and Examples 10.9 `@format' and `@smallformat' ================================= @@ -6645,7 +6772,7 @@ the `@format' command does not fill the text. small::. -File: texinfo.info, Node: exdent, Next: flushleft & flushright, Prev: format, Up: Quotations and Examples +File: texinfo, Node: exdent, Next: flushleft & flushright, Prev: format, Up: Quotations and Examples 10.10 `@exdent': Undoing a Line's Indentation ============================================= @@ -6663,7 +6790,7 @@ line is printed in the roman font. @exdent This line is exdented. This line follows the exdented line. The @@end example comes on the next line. - @end group + @end example produces @@ -6677,7 +6804,7 @@ un-indent text by ending the example and returning the page to its normal width. -File: texinfo.info, Node: flushleft & flushright, Next: noindent, Prev: exdent, Up: Quotations and Examples +File: texinfo, Node: flushleft & flushright, Next: noindent, Prev: exdent, Up: Quotations and Examples 10.11 `@flushleft' and `@flushright' ==================================== @@ -6718,7 +6845,7 @@ produces left end ragged. -File: texinfo.info, Node: noindent, Next: indent, Prev: flushleft & flushright, Up: Quotations and Examples +File: texinfo, Node: noindent, Next: indent, Prev: flushleft & flushright, Up: Quotations and Examples 10.12 `@noindent': Omitting Indentation ======================================= @@ -6769,7 +6896,7 @@ necessary, since `@noindent' is a command used outside of paragraphs (*note Command Syntax::). -File: texinfo.info, Node: indent, Next: cartouche, Prev: noindent, Up: Quotations and Examples +File: texinfo, Node: indent, Next: cartouche, Prev: noindent, Up: Quotations and Examples 10.13 `@indent': Forcing Indentation ==================================== @@ -6794,7 +6921,7 @@ since `@indent' is a command used outside of paragraphs (*note Command Syntax::). -File: texinfo.info, Node: cartouche, Prev: indent, Up: Quotations and Examples +File: texinfo, Node: cartouche, Prev: indent, Up: Quotations and Examples 10.14 `@cartouche': Rounded Rectangles Around Examples ====================================================== @@ -6833,7 +6960,7 @@ of `makeinfo' may be removed one day. `@cartouche' also implies `@group' (*note group::). -File: texinfo.info, Node: Lists and Tables, Next: Special Displays, Prev: Quotations and Examples, Up: Top +File: texinfo, Node: Lists and Tables, Next: Special Displays, Prev: Quotations and Examples, Up: Top 11 Lists and Tables ******************* @@ -6851,7 +6978,7 @@ first column; multi-column tables are also supported. * Multi-column Tables:: How to construct generalized tables. -File: texinfo.info, Node: Introducing Lists, Next: itemize, Up: Lists and Tables +File: texinfo, Node: Introducing Lists, Next: itemize, Up: Lists and Tables 11.1 Introducing Lists ====================== @@ -6907,7 +7034,7 @@ And here is a two-column table with the same items and their @-commands: Two-column tables, optionally with indexing. -File: texinfo.info, Node: itemize, Next: enumerate, Prev: Introducing Lists, Up: Lists and Tables +File: texinfo, Node: itemize, Next: enumerate, Prev: Introducing Lists, Up: Lists and Tables 11.2 `@itemize': Making an Itemized List ======================================== @@ -6985,7 +7112,7 @@ This produces: * Second outer item. -File: texinfo.info, Node: enumerate, Next: Two-column Tables, Prev: itemize, Up: Lists and Tables +File: texinfo, Node: enumerate, Next: Two-column Tables, Prev: itemize, Up: Lists and Tables 11.3 `@enumerate': Making a Numbered or Lettered List ===================================================== @@ -7075,7 +7202,7 @@ constructed using `@enumerate' with an argument of `a'. You can also nest enumerated lists, as in an outline. -File: texinfo.info, Node: Two-column Tables, Next: Multi-column Tables, Prev: enumerate, Up: Lists and Tables +File: texinfo, Node: Two-column Tables, Next: Multi-column Tables, Prev: enumerate, Up: Lists and Tables 11.4 Making a Two-column Table ============================== @@ -7093,7 +7220,7 @@ command-line option summaries. * itemx:: How to put more entries in the first column. -File: texinfo.info, Node: table, Next: ftable vtable, Up: Two-column Tables +File: texinfo, Node: table, Next: ftable vtable, Up: Two-column Tables 11.4.1 Using the `@table' Command --------------------------------- @@ -7164,7 +7291,7 @@ This produces: text, use the `@itemx' command. (*Note `@itemx': itemx.) -File: texinfo.info, Node: ftable vtable, Next: itemx, Prev: table, Up: Two-column Tables +File: texinfo, Node: ftable vtable, Next: itemx, Prev: table, Up: Two-column Tables 11.4.2 `@ftable' and `@vtable' ------------------------------ @@ -7187,7 +7314,7 @@ or `@end vtable' command on a line by itself. See the example for `@table' in the previous section. -File: texinfo.info, Node: itemx, Prev: ftable vtable, Up: Two-column Tables +File: texinfo, Node: itemx, Prev: ftable vtable, Up: Two-column Tables 11.4.3 `@itemx' --------------- @@ -7227,7 +7354,7 @@ This produces: a two-column table.) -File: texinfo.info, Node: Multi-column Tables, Prev: Two-column Tables, Up: Lists and Tables +File: texinfo, Node: Multi-column Tables, Prev: Two-column Tables, Up: Lists and Tables 11.5 `@multitable': Multi-column Tables ======================================= @@ -7246,7 +7373,7 @@ completes the table. Details in the sections below. * Multitable Rows:: Defining multitable rows, with examples. -File: texinfo.info, Node: Multitable Column Widths, Next: Multitable Rows, Up: Multi-column Tables +File: texinfo, Node: Multitable Column Widths, Next: Multitable Rows, Up: Multi-column Tables 11.5.1 Multitable Column Widths ------------------------------- @@ -7284,7 +7411,7 @@ entirely on the same line as the `@multitable' command. -File: texinfo.info, Node: Multitable Rows, Prev: Multitable Column Widths, Up: Multi-column Tables +File: texinfo, Node: Multitable Rows, Prev: Multitable Column Widths, Up: Multi-column Tables 11.5.2 Multitable Rows ---------------------- @@ -7297,7 +7424,8 @@ your source file as necessary. You can also use `@headitem' instead of `@item' to produce a "heading row". The TeX output for such a row is in bold, and the HTML, XML, and -Docbook output uses the `<thead>' tag. +Docbook output uses the `<thead>' tag. In Info, the heading row is +followed by a separator line made of dashes (`-' characters). Here is a complete example of a multi-column table (the text is from `The GNU Emacs Manual', *note Splitting Windows: (emacs)Split Window.): @@ -7333,7 +7461,7 @@ C-Mouse-2 In the mode line or scroll window. -File: texinfo.info, Node: Special Displays, Next: Indices, Prev: Lists and Tables, Up: Top +File: texinfo, Node: Special Displays, Next: Indices, Prev: Lists and Tables, Up: Top 12 Special Displays ******************* @@ -7356,7 +7484,7 @@ are often included in these displays. * Footnotes:: Writing footnotes. -File: texinfo.info, Node: Floats, Next: Images, Up: Special Displays +File: texinfo, Node: Floats, Next: Images, Up: Special Displays 12.1 Floats =========== @@ -7380,9 +7508,9 @@ simply output at the current location, more or less as if it were an * listoffloats:: A table of contents for floats. -File: texinfo.info, Node: float, Next: caption shortcaption, Up: Floats +File: texinfo, Node: float, Next: caption shortcaption, Up: Floats -12.1.1 `@float' [TYPE][,LABEL]: Floating material +12.1.1 `@float' [TYPE][,LABEL]: Floating Material ------------------------------------------------- To produce floating material, enclose the material you want to be @@ -7415,8 +7543,8 @@ TYPE LABEL Specifies a cross-reference label for this float. If given, this float is automatically given a number, and will appear in any - `@listofloats' output (*note listoffloats::). Cross-references to - LABEL are allowed. + `@listoffloats' output (*note listoffloats::). Cross-references + to LABEL are allowed. On the other hand, if LABEL is not given, then the float will not be numbered and consequently will not appear in the @@ -7436,7 +7564,7 @@ chapter, are simply numbered consecutively from 1. These numbering conventions are not, at present, changeable. -File: texinfo.info, Node: caption shortcaption, Next: listoffloats, Prev: float, Up: Floats +File: texinfo, Node: caption shortcaption, Next: listoffloats, Prev: float, Up: Floats 12.1.2 `@caption' & `@shortcaption' ----------------------------------- @@ -7469,12 +7597,22 @@ as specified to the `@float' command (see the previous section). `@float', and takes a single argument in braces. The short caption text is used instead of the caption text in a list of floats (see the next section). Thus, you can write a long caption for the main -document, and a short title to appear in the list of floats. +document, and a short title to appear in the list of floats. For +example: + + @float + ... as above ... + @shortcaption{Text for list of floats.} + @end float + + The text for `@caption' and `@shortcaption' may not contain comments +(`@c'), verbatim text (`@verb'), environments such as `@example', or +other complex constructs. -File: texinfo.info, Node: listoffloats, Prev: caption shortcaption, Up: Floats +File: texinfo, Node: listoffloats, Prev: caption shortcaption, Up: Floats -12.1.3 `@listoffloats': Tables of contents for floats +12.1.3 `@listoffloats': Tables of Contents for Floats ----------------------------------------------------- You can write a `@listoffloats' command to generate a list of floats @@ -7511,7 +7649,7 @@ to the float. In printed output, the page number is included. from the list of floats. -File: texinfo.info, Node: Images, Next: Footnotes, Prev: Floats, Up: Special Displays +File: texinfo, Node: Images, Next: Footnotes, Prev: Floats, Up: Special Displays 12.2 Inserting Images ===================== @@ -7527,12 +7665,12 @@ part of a displayed figure or example. * Image Scaling:: -File: texinfo.info, Node: Image Syntax, Next: Image Scaling, Up: Images +File: texinfo, Node: Image Syntax, Next: Image Scaling, Up: Images 12.2.1 Image Syntax ------------------- -Here is the basic synopsis of the `@image' command: +Here is the synopsis of the `@image' command: @image{FILENAME[, WIDTH[, HEIGHT[, ALTTEXT[, EXTENSION]]]]} @@ -7541,7 +7679,10 @@ because the different processors support different formats: * TeX reads the file `FILENAME.eps' (Encapsulated PostScript format). - * PDFTeX reads `FILENAME.pdf' (Adobe's Portable Document Format). + * pdfTeX reads `FILENAME.png', `FILENAME.jpg', `FILENAME.jpeg', or + `FILENAME.pdf' (in that order). It also tries uppercase versions + of the extensions. The PDF format cannot support EPS images, so + they must be converted first. * `makeinfo' includes `FILENAME.txt' verbatim for Info output (more or less as if it was an `@example'). @@ -7556,17 +7697,27 @@ because the different processors support different formats: The WIDTH and HEIGHT arguments are described in the next section. - When producing html, `makeinfo' sets the "alt attribute" for inline + For TeX output, if an image is the only thing in a paragraph it will +ordinarily be displayed on a line by itself, respecting the current +environment indentation, but without the normal paragraph indentation. +If you want it centered, use `@center' (*note `@titlefont @center @sp': +titlefont center sp.). + + For HTML output, `makeinfo' sets the "alt attribute" for inline images to the optional ALTTEXT (fourth) argument to `@image', if supplied. If not supplied, `makeinfo' uses the full file name of the -image being displayed. If you want an empty `alt' string, use `@-'. -The ALTTEXT is taken as Texinfo text, so special characters such as `"' -and `<' and `&' are escaped in the HTML and XML output. +image being displayed. The ALTTEXT is taken as Texinfo text, so +special characters such as `"' and `<' and `&' are escaped in the HTML +and XML output; also, you can get an empty `alt' string with `@-' (a +command that produces no output; *note - and hyphenation::). + + For Info output, the `alt' string is also processed as Texinfo text +and output. In this case, `\' is escaped as `\\' and `"' as `\"'; no +other escapes are done. If you do not supply the optional EXTENSION (fifth) argument, `makeinfo' first tries `FILENAME.png'; if that does not exist, it tries -`FILENAME.jpg'. If that does not exist either, it complains. (We -cannot support GIF format directly due to software patents.) +`FILENAME.jpg'. If that does not exist either, it complains. In Info output, `makeinfo' writes a reference to the binary image file (trying FILENAME suffixed with `EXTENSION', `.EXTENSION', `.png', @@ -7591,7 +7742,7 @@ feature was introduced in Texinfo version 4.6) will display the above literally, which, although not pretty, should not be harmful. -File: texinfo.info, Node: Image Scaling, Prev: Image Syntax, Up: Images +File: texinfo, Node: Image Scaling, Prev: Image Syntax, Up: Images 12.2.2 Image Scaling -------------------- @@ -7653,7 +7804,7 @@ line before the command, or the output will run into the preceding text. any other sort of output. -File: texinfo.info, Node: Footnotes, Prev: Images, Up: Special Displays +File: texinfo, Node: Footnotes, Prev: Images, Up: Special Displays 12.3 Footnotes ============== @@ -7676,7 +7827,7 @@ text. For a thorough discussion of footnotes, see `The Chicago Manual of Style', which is published by the University of Chicago Press. -File: texinfo.info, Node: Footnote Commands, Next: Footnote Styles, Up: Footnotes +File: texinfo, Node: Footnote Commands, Next: Footnote Styles, Up: Footnotes 12.3.1 Footnote Commands ------------------------ @@ -7725,7 +7876,7 @@ Two-column Tables::. (1) Here is the sample footnote. -File: texinfo.info, Node: Footnote Styles, Prev: Footnote Commands, Up: Footnotes +File: texinfo, Node: Footnote Styles, Prev: Footnote Commands, Up: Footnotes 12.3.2 Footnote Styles ---------------------- @@ -7791,7 +7942,7 @@ their default style. Currently, `texinfo-format-buffer' and the `end' style. -File: texinfo.info, Node: Indices, Next: Insertions, Prev: Special Displays, Up: Top +File: texinfo, Node: Indices, Next: Insertions, Prev: Special Displays, Up: Top 13 Indices ********** @@ -7821,7 +7972,7 @@ indices. * New Indices:: How to define your own indices. -File: texinfo.info, Node: Index Entries, Next: Predefined Indices, Up: Indices +File: texinfo, Node: Index Entries, Next: Predefined Indices, Up: Indices 13.1 Making Index Entries ========================= @@ -7845,7 +7996,7 @@ need to do it yourself. index at the end of a book or creating an index menu in an Info file. -File: texinfo.info, Node: Predefined Indices, Next: Indexing Commands, Prev: Index Entries, Up: Indices +File: texinfo, Node: Predefined Indices, Next: Indexing Commands, Prev: Index Entries, Up: Indices 13.2 Predefined Indices ======================= @@ -7899,7 +8050,7 @@ into one output index using the `@synindex' or `@syncodeindex' commands (*note Combining Indices::). -File: texinfo.info, Node: Indexing Commands, Next: Combining Indices, Prev: Predefined Indices, Up: Indices +File: texinfo, Node: Indexing Commands, Next: Combining Indices, Prev: Predefined Indices, Up: Indices 13.3 Defining the Entries of an Index ===================================== @@ -7958,7 +8109,7 @@ Text::), and `@r' for the normal roman font (*note Fonts::). information about the structure of a menu entry. -File: texinfo.info, Node: Combining Indices, Next: New Indices, Prev: Indexing Commands, Up: Indices +File: texinfo, Node: Combining Indices, Next: New Indices, Prev: Indexing Commands, Up: Indices 13.4 Combining Indices ====================== @@ -7987,7 +8138,7 @@ enclose every one of them between the braces of `@code'. default font of the merged-to index. -File: texinfo.info, Node: syncodeindex, Next: synindex, Up: Combining Indices +File: texinfo, Node: syncodeindex, Next: synindex, Up: Combining Indices 13.4.1 `@syncodeindex' ---------------------- @@ -8046,7 +8197,7 @@ into a concept index, all the function names are printed in the `@code' font as you would expect. -File: texinfo.info, Node: synindex, Prev: syncodeindex, Up: Combining Indices +File: texinfo, Node: synindex, Prev: syncodeindex, Up: Combining Indices 13.4.2 `@synindex' ------------------ @@ -8060,7 +8211,7 @@ command, except that it does not put the `from' index entries into the index at the end of a book or creating an index menu in an Info file. -File: texinfo.info, Node: New Indices, Prev: Combining Indices, Up: Indices +File: texinfo, Node: New Indices, Prev: Combining Indices, Up: Indices 13.5 Defining New Indices ========================= @@ -8113,7 +8264,7 @@ Texinfo file, and (of course) before any `@synindex' or `@syncodeindex' commands (*note Texinfo File Header::). -File: texinfo.info, Node: Insertions, Next: Breaks, Prev: Indices, Up: Top +File: texinfo, Node: Insertions, Next: Breaks, Prev: Indices, Up: Top 14 Special Insertions ********************* @@ -8125,20 +8276,26 @@ elements that do not correspond to simple characters you can type. * Menu: * Atsign Braces Comma:: Inserting @ and {} and ,. +* Inserting Quote Characters:: Inserting left and right quotes, in code. * Inserting Space:: How to insert the right amount of space within a sentence. * Inserting Accents:: How to insert accents and special characters. +* Inserting Quotation Marks:: How to insert quotation marks. * Dots Bullets:: How to insert dots and bullets. * TeX and copyright:: How to insert the TeX logo and the copyright symbol. +* euro:: How to insert the Euro currency symbol. * pounds:: How to insert the pounds currency symbol. +* textdegree:: How to insert the degrees symbol. * minus:: How to insert a minus sign. +* geq leq:: How to insert greater/less-than-or-equal signs. * math:: How to format a mathematical expression. +* Click Sequences:: Inserting GUI usage sequences. * Glyphs:: How to indicate results of evaluation, expansion of macros, errors, etc. -File: texinfo.info, Node: Atsign Braces Comma, Next: Inserting Space, Up: Insertions +File: texinfo, Node: Atsign Braces Comma, Next: Inserting Quote Characters, Up: Insertions 14.1 Inserting @ and {} and , ============================= @@ -8157,7 +8314,7 @@ separates arguments to commands that take multiple arguments. * Inserting a Comma:: -File: texinfo.info, Node: Inserting an Atsign, Next: Inserting Braces, Up: Atsign Braces Comma +File: texinfo, Node: Inserting an Atsign, Next: Inserting Braces, Up: Atsign Braces Comma 14.1.1 Inserting `@' with `@@' ------------------------------ @@ -8167,7 +8324,7 @@ File: texinfo.info, Node: Inserting an Atsign, Next: Inserting Braces, Up: At Do not put braces after an `@@' command. -File: texinfo.info, Node: Inserting Braces, Next: Inserting a Comma, Prev: Inserting an Atsign, Up: Atsign Braces Comma +File: texinfo, Node: Inserting Braces, Next: Inserting a Comma, Prev: Inserting an Atsign, Up: Atsign Braces Comma 14.1.2 Inserting `{' and `}' with `@{' and `@}' ----------------------------------------------- @@ -8176,10 +8333,10 @@ File: texinfo.info, Node: Inserting Braces, Next: Inserting a Comma, Prev: In `@}' stands for a single `}' in either printed or Info output. - Do not put braces after either an `@{' or an `@}' command.ppp + Do not put braces after either an `@{' or an `@}' command. -File: texinfo.info, Node: Inserting a Comma, Prev: Inserting Braces, Up: Atsign Braces Comma +File: texinfo, Node: Inserting a Comma, Prev: Inserting Braces, Up: Atsign Braces Comma 14.1.3 Inserting `,' with `@comma{}' ------------------------------------ @@ -8193,21 +8350,64 @@ context: some commands, such as `@acronym' (*note acronym::) and (*note Defining Macros::), can take more than one argument. In these cases, the comma character is used to separate arguments. - Since a comma chacter would confuse Texinfo's parsing for these -commands, you must use the command `,' instead if you want to have an -actual comma in the output. Here are some examples: + Since a comma character would confuse Texinfo's parsing for these +commands, you must use the command `@comma{}' instead if you want to +pass an actual comma. Here are some examples: @acronym{ABC, A Bizarre @comma{}} @xref{Comma,, The @comma{} symbol} @mymac{One argument@comma{} containing a comma} - Although , can be used anywhere, there is no need for it anywhere -except in this unusual case. + Although , can be used nearly anywhere, there is no need for it +anywhere except in this unusual case. + + +File: texinfo, Node: Inserting Quote Characters, Next: Inserting Space, Prev: Atsign Braces Comma, Up: Insertions + +14.2 Inserting Quote Characters +=============================== + +As explained in the early section on general Texinfo input conventions +(*note Conventions::), Texinfo source files use the ASCII character ``' +(96 decimal) to produce a left quote (`), and ASCII `'' (39 decimal) to +produce a right quote ('). Doubling these input characters (```' and +`''') produces double quotes (" and "). These are the conventions used +by TeX. + + This works all right for text. However, in examples of computer code, +readers are especially likely to cut and paste the text verbatim--and, +unfortunately, some document viewers will mangle these characters. +(The free PDF reader `xpdf' works fine, but other PDF readers, both +free and nonfree, have problems.) + + If this is a concern for your document, Texinfo provides two special +settings via `@set': + +`@set txicodequoteundirected' + causes the output for the `'' character to be the undirected + single quote, like this: + + `''. + +`@set txicodequotebacktick' + Cause the output for the ``' character to be the standalone grave + accent, like this: + + ``'. + + + `xyza`'bc' + + If you want these settings for only part of the document, `@clear' +will restore the normal behavior, as in `@clear txicodequoteundirected'. + + These settings affect `@code', `@example', and `@verbatim'; they do +not affect `@samp'. (*Note Useful Highlighting::.) -File: texinfo.info, Node: Inserting Space, Next: Inserting Accents, Prev: Atsign Braces Comma, Up: Insertions +File: texinfo, Node: Inserting Space, Next: Inserting Accents, Prev: Inserting Quote Characters, Up: Insertions -14.2 Inserting Space +14.3 Inserting Space ==================== The following sections describe commands that control spacing of various @@ -8218,12 +8418,13 @@ kinds within and after sentences. * Not Ending a Sentence:: Sometimes a . doesn't end a sentence. * Ending a Sentence:: Sometimes it does. * Multiple Spaces:: Inserting multiple spaces. +* frenchspacing:: Specifying end-of-sentence spacing. * dmn:: How to format a dimension. -File: texinfo.info, Node: Not Ending a Sentence, Next: Ending a Sentence, Up: Inserting Space +File: texinfo, Node: Not Ending a Sentence, Next: Ending a Sentence, Up: Inserting Space -14.2.1 Not Ending a Sentence +14.3.1 Not Ending a Sentence ---------------------------- Depending on whether a period or exclamation point or question mark is @@ -8243,18 +8444,15 @@ sentences. For example, - The s.o.p.@: has three parts ... - The s.o.p. has three parts ... + foo vs.@: bar + foo vs. bar produces - The s.o.p. has three parts ... - The s.o.p. has three parts ... + foo vs. bar + foo vs. bar -(Incidentally, `s.o.p.' is an abbreviation for "Standard Operating -Procedure".) - - `@:' has no effect on the Info and HTML output. In Docbook and XML, +`@:' has no effect on the Info and HTML output. In Docbook and XML, the previous punctuation character (.?!:) is output as an entity instead of as the normal character: `. ? ! :'. This gives further processors a chance to notice and not add the usual @@ -8263,9 +8461,9 @@ extra space. Do not put braces after `@:' (or any non-alphabetic command). -File: texinfo.info, Node: Ending a Sentence, Next: Multiple Spaces, Prev: Not Ending a Sentence, Up: Inserting Space +File: texinfo, Node: Ending a Sentence, Next: Multiple Spaces, Prev: Not Ending a Sentence, Up: Inserting Space -14.2.2 Ending a Sentence +14.3.2 Ending a Sentence ------------------------ Use `@.' instead of a period, `@!' instead of an exclamation point, and @@ -8292,9 +8490,9 @@ with the Emacs sentence motion commands (*note Sentences: Do not put braces after any of these commands. -File: texinfo.info, Node: Multiple Spaces, Next: dmn, Prev: Ending a Sentence, Up: Inserting Space +File: texinfo, Node: Multiple Spaces, Next: frenchspacing, Prev: Ending a Sentence, Up: Inserting Space -14.2.3 Multiple Spaces +14.3.3 Multiple Spaces ---------------------- Ordinarily, TeX collapses multiple whitespace characters (space, tab, @@ -8325,12 +8523,63 @@ produces Do not follow any of these commands with braces. - To produce a non-breakable space, see *Note `@tie': tie. + To produce a non-breakable space, see *note `@tie': tie. -File: texinfo.info, Node: dmn, Prev: Multiple Spaces, Up: Inserting Space +File: texinfo, Node: frenchspacing, Next: dmn, Prev: Multiple Spaces, Up: Inserting Space + +14.3.4 `@frenchspacing' VAL: Control sentence spacing +----------------------------------------------------- + +In American typography, it is traditional and correct to put extra +space at the end of a sentence, after a semi-colon, and so on. This is +the default in Texinfo. In French typography (and many others), this +extra space is wrong; all spaces are uniform. + + Therefore Texinfo provides the `@frenchspacing' command to control +the spacing after punctuation. It reads the rest of the line as its +argument, which must be the single word `on' or `off' (always these +words, regardless of the language) of the document. Here is an example: + + @frenchspacing on + This is text. Two sentences. Three sentences. French spacing. + + @frenchspacing off + This is text. Two sentences. Three sentences. Non-French spacing. + +produces (there will be no difference in Info): + + This is text. Two sentences. Three sentences. French spacing. + + This is text. Two sentences. Three sentences. Non-French spacing. + + `@frenchspacing' mainly affects the printed output, including the +output after `@.', `@!', and `@?' (*note Ending a Sentence::). + + In Info, usually space characters in the input are written unaltered +to the output, and `@frenchspacing' does not change this. It does +change the one case where `makeinfo' outputs a space on its own: when a +sentence ends at a newline in the source. Here's an example: -14.2.4 `@dmn'{DIMENSION}: Format a Dimension + Some sentence. + Next sentence. + +produces in Info output, with `@frenchspacing off' (the default), two +spaces between the sentences: + + Some sentence. Next sentence. + +With `@frenchspacing on', `makeinfo' outputs only a single space: + + Some sentence. Next sentence. + + `@frenchspacing' has no effect on the HTML or Docbook output; for +XML, it outputs a transliteration of itself (*note Output Formats::). + + +File: texinfo, Node: dmn, Prev: frenchspacing, Up: Inserting Space + +14.3.5 `@dmn'{DIMENSION}: Format a Dimension -------------------------------------------- At times, you may want to write `12pt' or `8.5in' with little or no @@ -8359,9 +8608,9 @@ the period to prevent TeX from inserting extra whitespace, as shown here. *Note Not Ending a Sentence::. -File: texinfo.info, Node: Inserting Accents, Next: Dots Bullets, Prev: Inserting Space, Up: Insertions +File: texinfo, Node: Inserting Accents, Next: Inserting Quotation Marks, Prev: Inserting Space, Up: Insertions -14.3 Inserting Accents +14.4 Inserting Accents ====================== Here is a table with the commands Texinfo provides for inserting @@ -8372,10 +8621,12 @@ as to make the source as convenient to type and read as possible, since accented characters are very common in some languages. To get the true accented characters output in Info, and not just the -ASCII transliterations, you can use the `--enable-encoding' option to -`makeinfo' (*note makeinfo options::). +ASCII transliterations, it is necessary to specify `@documentencoding' +with an encoding which supports the required characters (*note +`@documentencoding': documentencoding.). Command Output What +------------------------------------------------------ @"o o" umlaut accent @'o o' acute accent @,{c} c, cedilla accent @@ -8395,22 +8646,97 @@ Command Output What This table lists the Texinfo commands for inserting other characters commonly used in languages other than English. -@exclamdown{} ! upside-down ! -@questiondown{} ? upside-down ? -@aa{} @AA{} aa AA a,A with circle -@ae{} @AE{} ae AE ae,AE ligatures -@dotless{i} i dotless i -@dotless{j} j dotless j -@l{} @L{} /l /L suppressed-L,l -@o{} @O{} /o /O O,o with slash -@oe{} @OE{} oe OE oe,OE ligatures -@ordf{} @ordm{} a o Spanish ordinals -@ss{} ss es-zet or sharp S +@exclamdown{} ! upside-down ! +@questiondown{} ? upside-down ? +@aa{} @AA{} aa AA a,A with circle +@ae{} @AE{} ae AE ae,AE ligatures +@dotless{i} i dotless i +@dotless{j} j dotless j +@l{} @L{} /l /L suppressed-L,l +@o{} @O{} /o /O O,o with slash +@oe{} @OE{} oe OE oe,OE ligatures +@ordf{} @ordm{} a o Spanish ordinals +@ss{} ss es-zet or sharp S -File: texinfo.info, Node: Dots Bullets, Next: TeX and copyright, Prev: Inserting Accents, Up: Insertions +File: texinfo, Node: Inserting Quotation Marks, Next: Dots Bullets, Prev: Inserting Accents, Up: Insertions -14.4 Inserting Ellipsis and Bullets +14.5 Inserting Quotation Marks +============================== + +Use doubled single-quote characters to begin and end quotations: +``...''. TeX converts two single quotes to left- and right-hand +doubled quotation marks, and Info converts doubled single-quote +characters to ASCII double-quotes: ``...'' becomes "...". + + You may occasionally need to produce two consecutive single quotes; +for example, in documenting a computer language such as Maxima where '' +is a valid command. You can do this with the input '@w{}'; the empty +`@w' command stops the combination into the double-quote characters. + + The left quote character (`, ASCII code 96) used in Texinfo is a +grave accent in ANSI and ISO character set standards. We use it as a +quote character because that is how TeX is set up, by default. + + Texinfo supports several other quotation marks used in languages other +than English. Below is a table with the commands Texinfo provides for +inserting quotation marks. + + In order to get the symbols for the quotation marks in encoded Info +output, it is necessary to specify `@documentencoding UTF-8'. (*Note +`@documentencoding': documentencoding.) Double guillemets are also +present in ISO 8859-1 (aka Latin 1) and ISO 8859-15 (aka Latin 9). + + The standard TeX fonts support the usual quotation marks used in +English (the ones produced with single and doubled ASCII +single-quotes). For the other quotation marks, TeX uses European +Computer Modern (EC) fonts (`ecrm1000' and other variants). These +fonts are freely available, of course; you can download them from +`http://www.ctan.org/tex-archive/fonts/ec', among other places. + + The free EC fonts are bitmap fonts created with Metafont. Especially +for on-line viewing, Type 1 (vector) versions of the fonts are +preferable; these are available in the CM-Super font package +(`http://www.ctan.org/tex-archive/fonts/ps-type1/cm-super'). + + Both distributions include installation instructions. + +Command Glyph Unicode name (point) +------------------------------------------------------------------------------------ +@quotedblleft{} `` " Left double quotation mark (U+201C) +@quotedblright{} '' " Right double quotation mark (U+201D) +@quoteleft{} ` ` Left single quotation mark (U+2018) +@quoteright{} ' ' Right single quotation mark (U+2019) +@quotedblbase{} " Double low-9 quotation mark (U+201E) +@quotesinglbase{} , Single low-9 quotation mark (U+201A) +@guillemetleft{} << Left-pointing double angle quotation mark (U+00AB) +@guillemetright{} >> Right-pointing double angle quotation mark (U+00BB) +@guilsinglleft{} < Single left-pointing angle quotation mark (U+2039) +@guilsinglright{} > Single right-pointing angle quotation mark (U+203A) + + For the double angle quotation marks, Adobe and LaTeX glyph names are +also supported: `@guillemotleft' and `@guillemotright'. These names +are actually incorrect; a "guillemot" is a bird species (a type of auk). + + Traditions for quotation mark usage vary to a great extent between +languages +(`http://en.wikipedia.org/wiki/Quotation_mark%2C_non-English_usage#Overview'). +Texinfo does not provide commands for typesetting quotation marks +according to the numerous traditions. Therefore, you have to choose +the commands appropriate for the language of your manual. Sometimes +aliases (*note `@alias': alias.) can simplify the usage and make the +source code more readable. For example, in German, `@quotedblbase' is +used for the left double quote, and the right double quote is actually +`@quotedblleft', which is counter-intuitive. Thus, in this case the +following aliases would be convenient: + + @alias lgqq = quotedblbase + @alias rgqq = quotedblleft + + +File: texinfo, Node: Dots Bullets, Next: TeX and copyright, Prev: Inserting Quotation Marks, Up: Insertions + +14.6 Inserting Ellipsis and Bullets =================================== An "ellipsis" (a line of dots) is not typeset as a string of periods, @@ -8428,10 +8754,10 @@ information.) * bullet:: How to insert a bullet. -File: texinfo.info, Node: dots, Next: bullet, Up: Dots Bullets +File: texinfo, Node: dots, Next: bullet, Up: Dots Bullets -14.4.1 `@dots'{} (...) and `@enddots'{} (....) ----------------------------------------------- +14.6.1 `@dots'{} (...) and `@enddots'{} (...) +--------------------------------------------- Use the `@dots{}' command to generate an ellipsis, which is three dots in a row, appropriately spaced ... like so. Do not simply write three @@ -8440,13 +8766,13 @@ but would produce the wrong amount of space between the periods in the printed manual. Similarly, the `@enddots{}' command generates an end-of-sentence -ellipsis, which has different spacing afterwards, .... Look closely to +ellipsis, which has different spacing afterwards, ... Look closely to see the difference. -File: texinfo.info, Node: bullet, Prev: dots, Up: Dots Bullets +File: texinfo, Node: bullet, Prev: dots, Up: Dots Bullets -14.4.2 `@bullet'{} (*) +14.6.2 `@bullet'{} (*) ---------------------- Use the `@bullet{}' command to generate a large round dot, or the @@ -8458,9 +8784,9 @@ closest possible thing to one. In Info, an asterisk is used. braces, because `@itemize' supplies them. (*Note `@itemize': itemize.) -File: texinfo.info, Node: TeX and copyright, Next: pounds, Prev: Dots Bullets, Up: Insertions +File: texinfo, Node: TeX and copyright, Next: euro, Prev: Dots Bullets, Up: Insertions -14.5 Inserting TeX and Legal Symbols: (C), (R) +14.7 Inserting TeX and Legal Symbols: (C), (R) ============================================== The logo `TeX' is typeset in a special fashion and it needs an @@ -8476,9 +8802,9 @@ braces. * registered symbol:: The registered symbol (R in a circle). -File: texinfo.info, Node: tex, Next: copyright symbol, Up: TeX and copyright +File: texinfo, Node: tex, Next: copyright symbol, Up: TeX and copyright -14.5.1 `@TeX'{} (TeX) and `@LaTeX'{} (LaTeX) +14.7.1 `@TeX'{} (TeX) and `@LaTeX'{} (LaTeX) -------------------------------------------- Use the `@TeX{}' command to generate `TeX'. In a printed manual, this @@ -8495,18 +8821,18 @@ that it emphasizes logical structure, but much (much) larger.) that they use both uppercase and lowercase letters. -File: texinfo.info, Node: copyright symbol, Next: registered symbol, Prev: tex, Up: TeX and copyright +File: texinfo, Node: copyright symbol, Next: registered symbol, Prev: tex, Up: TeX and copyright -14.5.2 `@copyright{}' ((C)) +14.7.2 `@copyright{}' ((C)) --------------------------- Use the `@copyright{}' command to generate the copyright symbol, `(C)'. Where possible, this is a `c' inside a circle; in Info, this is `(C)'. -File: texinfo.info, Node: registered symbol, Prev: copyright symbol, Up: TeX and copyright +File: texinfo, Node: registered symbol, Prev: copyright symbol, Up: TeX and copyright -14.5.3 `@registeredsymbol{}' ((R)) +14.7.3 `@registeredsymbol{}' ((R)) ---------------------------------- Use the `@registeredsymbol{}' command to generate the registered @@ -8514,20 +8840,60 @@ symbol, `(R)'. Where possible, this is an `R' inside a circle; in Info, this is `(R)'. -File: texinfo.info, Node: pounds, Next: minus, Prev: TeX and copyright, Up: Insertions +File: texinfo, Node: euro, Next: pounds, Prev: TeX and copyright, Up: Insertions + +14.8 `@euro'{} (Euro ): Euro Currency Symbol +============================================ + +Use the `@euro{}' command to generate `Euro '. Where possible, this is +the symbol for the Euro currency, invented as part of the European +economic unification. In plain Info, it is the word `Euro '. A +trailing space is included in the text transliteration since typically +no space is desired after the symbol, so it would be inappropriate to +have a space in the source document. + + Texinfo cannot magically synthesize support for the Euro symbol where +the underlying system (fonts, software, whatever) does not support it. +Therefore, in many cases it is preferable to use the word "Euro". (In +banking circles, the abbreviation for the Euro is EUR.) -14.6 `@pounds'{} (#): Pounds Sterling + In order to get the Euro symbol in encoded Info output, for example, +it is necessary to specify `@documentencoding ISO-8859-15'. (*Note +`@documentencoding': documentencoding.) The Euro symbol is in ISO +8859-15 (aka Latin 9), and is _not_ in the more widely-used and +supported ISO 8859-1 (Latin 1). + + The Euro symbol does not exist in the standard TeX fonts (which were +designed before the Euro was legislated into existence). Therefore, +TeX uses an additional font, named `feymr10' (along with other +variables). It is freely available, of course; you can download it +from `http://www.ctan.org/tex-archive/fonts/eurosym', among other +places. The distribution includes installation instructions. + + +File: texinfo, Node: pounds, Next: textdegree, Prev: euro, Up: Insertions + +14.9 `@pounds'{} (#): Pounds Sterling ===================================== -Use the `@pounds{}' command to generate `#'. In a printed manual, this -is the symbol for the currency pounds sterling. In Info, it is a `#'. -Other currency symbols are unfortunately not available. +Use the `@pounds{}' command to generate `#'. Where possible, this is +the symbol for the currency pounds sterling. In Info, it is a `#'. -File: texinfo.info, Node: minus, Next: math, Prev: pounds, Up: Insertions +File: texinfo, Node: textdegree, Next: minus, Prev: pounds, Up: Insertions -14.7 `@minus'{} (-): Inserting a Minus Sign -=========================================== +14.10 `@textdegree'{} (o): Degrees Symbol +========================================= + +Use the `@textdegree{}' command to generate `o'. Where possible, this +is the normal symbol for degrees. In plain text and Info output, it is +an `o'. + + +File: texinfo, Node: minus, Next: geq leq, Prev: textdegree, Up: Insertions + +14.11 `@minus'{} (-): Inserting a Minus Sign +============================================ Use the `@minus{}' command to generate a minus sign. In a fixed-width font, this is a single hyphen, but in a proportional font, the symbol @@ -8551,10 +8917,20 @@ itemized list, you do not need to type the braces (*note `@itemize': itemize.). -File: texinfo.info, Node: math, Next: Glyphs, Prev: minus, Up: Insertions +File: texinfo, Node: geq leq, Next: math, Prev: minus, Up: Insertions -14.8 `@math': Inserting Mathematical Expressions -================================================ +14.12 `@geq{}' (>=) and `@leq{}' (<=): Inserting relations +========================================================== + +Use the `@geq{}' and `@geq{}' commands to generate +greater-than-or-equal and less-than-equal-signs, `>=' and `<='. In +plain text and Info output, these are the ASCII sequences `>=' and `<='. + + +File: texinfo, Node: math, Next: Click Sequences, Prev: geq leq, Up: Insertions + +14.13 `@math': Inserting Mathematical Expressions +================================================= You can write a short mathematical expression with the `@math' command. Write the mathematical expression between braces, like this: @@ -8565,21 +8941,35 @@ This produces the following in Info and HTML: (a + b)(a + b) = a^2 + 2ab + b^2 - Thus, the `@math' command has no effect on the Info and HTML output; -`makeinfo' just reproduces the input, it does not try to interpret the -mathematics in any way. + The `@math' command has no special effect on the Info and HTML +output. `makeinfo' expands any `@'-commands as usual, but it does not +try to produce good mathematical formatting in any way. + + However, as far as the TeX output is concerned, plain TeX +mathematical commands are allowed in `@math', starting with `\', and +the plain TeX math characters like `^' and `_' are also recognized. In +essence, `@math' drops you into plain TeX math mode. + + This allows you to conveniently write superscripts and subscripts (as +in the above example), and also to use all the plain TeX math control +sequences for symbols, functions, and so on, and thus get proper +formatting in the TeX output, at least. + + It's best to use `\' instead of `@' for any such mathematical +commands; otherwise, `makeinfo' will complain. On the other hand, +input with matching (but unescaped) braces, such as `k_{75}', is +allowed inside `@math', although `makeinfo' would complain about the +bare braces in regular input. + + Here's an example: - `@math' implies `@tex'. This not only makes it possible to write -superscripts and subscripts (as in the above example), but also allows -you to use any of the plain TeX math control sequences. It's -conventional to use `\' instead of `@' for these commands. As in: @math{\sin 2\pi \equiv \cos 3\pi} which looks like the input in Info and HTML: \sin 2\pi \equiv \cos 3\pi Since `\' is an escape character inside `@math', you can use `@\' to -get a literal backslash (`\\' will work in TeX, but you'll get the +get a literal backslash (`\\' will work in TeX, but you'd get the literal `\\' in Info). `@\' is not defined outside of `@math', since a `\' ordinarily produces a literal `\'. @@ -8587,10 +8977,44 @@ literal `\\' in Info). `@\' is not defined outside of `@math', since a Raw Formatter Commands::). -File: texinfo.info, Node: Glyphs, Prev: math, Up: Insertions +File: texinfo, Node: Click Sequences, Next: Glyphs, Prev: math, Up: Insertions -14.9 Glyphs for Examples -======================== +14.14 Click Sequences +===================== + +When documenting graphical interfaces, it is necessary to describe +sequences such as `Click on `File', then choose `Open', then ...'. +Texinfo offers commands `@clicksequence' and `click' to represent this, +typically used like this: + + ... @clicksequence{File @click{} Open} ... + +which produces: + + ... File -> Open ... + + The `@click' command produces a simple right arrow (`->' in Info) by +default; this glyph is also available independently via the command +`@arrow{}'. + + You can change the glyph produced by `@click' with the command +`@clickstyle', which takes a command name as its single argument on the +rest of the line, much like `@itemize' and friends (*note `@itemize': +itemize.). The command should produce a glyph, and the usual empty +braces `{}' are omitted. Here's an example: + + @clickstyle @result + ... @clicksequence{File @click{} Open} ... + +now produces: + + ... File => Open ... + + +File: texinfo, Node: Glyphs, Prev: Click Sequences, Up: Insertions + +14.15 Glyphs for Examples +========================= In Texinfo, code is often illustrated in examples that are delimited by `@example' and `@end example', or by `@lisp' and `@end lisp'. In such @@ -8614,10 +9038,10 @@ followed by a pair of left- and right-hand braces. * Point Glyph:: How to indicate the location of point. -File: texinfo.info, Node: Glyphs Summary, Next: result, Up: Glyphs +File: texinfo, Node: Glyphs Summary, Next: result, Up: Glyphs -14.9.1 Glyphs Summary ---------------------- +14.15.1 Glyphs Summary +---------------------- Here are the different glyph commands: @@ -8649,10 +9073,10 @@ error--> * Point Glyph:: -File: texinfo.info, Node: result, Next: expansion, Prev: Glyphs Summary, Up: Glyphs +File: texinfo, Node: result, Next: expansion, Prev: Glyphs Summary, Up: Glyphs -14.9.2 `@result{}' (=>): Indicating Evaluation ----------------------------------------------- +14.15.2 `@result{}' (=>): Indicating Evaluation +----------------------------------------------- Use the `@result{}' command to indicate the result of evaluating an expression. @@ -8668,10 +9092,10 @@ a true double stemmed arrow in the printed output. may be read as "`(cdr '(1 2 3))' evaluates to `(2 3)'". -File: texinfo.info, Node: expansion, Next: Print Glyph, Prev: result, Up: Glyphs +File: texinfo, Node: expansion, Next: Print Glyph, Prev: result, Up: Glyphs -14.9.3 `@expansion{}' (==>): Indicating an Expansion ----------------------------------------------------- +14.15.3 `@expansion{}' (==>): Indicating an Expansion +----------------------------------------------------- When an expression is a macro call, it expands into a new expression. You can indicate the result of the expansion with the `@expansion{}' @@ -8703,10 +9127,10 @@ Often, as in this case, an example looks better if the `@expansion{}' and `@result{}' commands are indented. -File: texinfo.info, Node: Print Glyph, Next: Error Glyph, Prev: expansion, Up: Glyphs +File: texinfo, Node: Print Glyph, Next: Error Glyph, Prev: expansion, Up: Glyphs -14.9.4 `@print{}' (-|): Indicating Printed Output -------------------------------------------------- +14.15.4 `@print{}' (-|): Indicating Printed Output +-------------------------------------------------- Sometimes an expression will print output during its execution. You can indicate the printed output with the `@print{}' command. @@ -8733,10 +9157,10 @@ In a Texinfo source file, this example is written as follows: @end lisp -File: texinfo.info, Node: Error Glyph, Next: Equivalence, Prev: Print Glyph, Up: Glyphs +File: texinfo, Node: Error Glyph, Next: Equivalence, Prev: Print Glyph, Up: Glyphs -14.9.5 `@error{}' (error-->): Indicating an Error Message ---------------------------------------------------------- +14.15.5 `@error{}' (error-->): Indicating an Error Message +---------------------------------------------------------- A piece of code may cause an error when you evaluate it. You can designate the error message with the `@error{}' command. @@ -8764,10 +9188,10 @@ evaluate the expression: `error-->' itself is not part of the error message. -File: texinfo.info, Node: Equivalence, Next: Point Glyph, Prev: Error Glyph, Up: Glyphs +File: texinfo, Node: Equivalence, Next: Point Glyph, Prev: Error Glyph, Up: Glyphs -14.9.6 `@equiv{}' (==): Indicating Equivalence ----------------------------------------------- +14.15.6 `@equiv{}' (==): Indicating Equivalence +----------------------------------------------- Sometimes two expressions produce identical results. You can indicate the exact equivalence of two forms with the `@equiv{}' command. @@ -8790,10 +9214,10 @@ This indicates that evaluating `(make-sparse-keymap)' produces identical results to evaluating `(list 'keymap)'. -File: texinfo.info, Node: Point Glyph, Prev: Equivalence, Up: Glyphs +File: texinfo, Node: Point Glyph, Prev: Equivalence, Up: Glyphs -14.9.7 `@point{}' (-!-): Indicating Point in a Buffer ------------------------------------------------------ +14.15.7 `@point{}' (-!-): Indicating Point in a Buffer +------------------------------------------------------ Sometimes you need to show an example of text in an Emacs buffer. In such examples, the convention is to include the entire contents of the @@ -8836,7 +9260,7 @@ after evaluating a Lisp command to insert the word `changed'. @end example -File: texinfo.info, Node: Breaks, Next: Definition Commands, Prev: Insertions, Up: Top +File: texinfo, Node: Breaks, Next: Definition Commands, Prev: Insertions, Up: Top 15 Forcing and Preventing Breaks ******************************** @@ -8859,6 +9283,7 @@ commands. * Break Commands:: Summary of break-related commands. * Line Breaks:: Forcing line breaks. * - and hyphenation:: Helping TeX with hyphenation points. +* allowcodebreaks:: Controlling line breaks within @code text. * w:: Preventing unwanted line breaks in text. * tie:: Inserting an unbreakable but varying space. * sp:: Inserting blank lines. @@ -8867,7 +9292,7 @@ commands. * need:: Another way to prevent unwanted page breaks. -File: texinfo.info, Node: Break Commands, Next: Line Breaks, Up: Breaks +File: texinfo, Node: Break Commands, Next: Line Breaks, Up: Breaks 15.1 Break Commands =================== @@ -8908,7 +9333,7 @@ files do not have pages. Start a new printed page if not enough space on this one. -File: texinfo.info, Node: Line Breaks, Next: - and hyphenation, Prev: Break Commands, Up: Breaks +File: texinfo, Node: Line Breaks, Next: - and hyphenation, Prev: Break Commands, Up: Breaks 15.2 `@*' and `@/': Generate and Allow Line Breaks ================================================== @@ -8941,7 +9366,7 @@ Without the `@/' commands, TeX would have nowhere to break the line. `@/' has no effect in the online output. -File: texinfo.info, Node: - and hyphenation, Next: w, Prev: Line Breaks, Up: Breaks +File: texinfo, Node: - and hyphenation, Next: allowcodebreaks, Prev: Line Breaks, Up: Breaks 15.3 `@-' and `@hyphenation': Helping TeX Hyphenate =================================================== @@ -8964,14 +9389,45 @@ wish to help TeX out. Texinfo supports two commands for this: a `-' at each hyphenation point. For example: @hyphenation{man-u-script man-u-scripts} TeX only uses the specified hyphenation points when the words - match exactly, so give all necessary variants. + match exactly, so give all necessary variants, such as plurals. + + Info, HTML, and other non-TeX output is not hyphenated, so none of +these commands have any effect there. - Info output is not hyphenated, so these commands have no effect there. + +File: texinfo, Node: allowcodebreaks, Next: w, Prev: - and hyphenation, Up: Breaks + +15.4 `@allowcodebreaks': Control Line Breaks in `@code' +======================================================= + +Ordinarily, TeX will consider breaking lines at `-' and `_' characters +within `@code' and related commands (*note `@code': code.), more or +less as if they were "empty" hyphenation points. + + This is necessary as many manuals, especially for Lisp-family +languages, must document very long identifiers. On the other hand, +other manuals don't have this problems, and you may not wish to allow a +line break at the underscore in, for example, `SIZE_MAX', or even +worse, after any of the four underscores in `__typeof__'. + + So Texinfo provides this command: + + @allowcodebreaks false + +to prevent TeX from breaking at `-' or `_' within `@code'. You can go +back to allowing such breaks with `@allowcodebreaks true'. Write these +commands on lines by themselves. + + These commands can be given anywhere in the document. For example, +you may have just one problematic paragraph where you need to turn off +the breaks, but want them in general, or vice versa. + + This command has no effect in Info, HTML, and other non-TeX output. -File: texinfo.info, Node: w, Next: tie, Prev: - and hyphenation, Up: Breaks +File: texinfo, Node: w, Next: tie, Prev: allowcodebreaks, Up: Breaks -15.4 `@w'{TEXT}: Prevent Line Breaks +15.5 `@w'{TEXT}: Prevent Line Breaks ==================================== `@w{TEXT}' outputs TEXT and prohibits line breaks within TEXT, for both @@ -8988,7 +9444,7 @@ produces: The space from `@w{ }', as well as being non-breakable, also will not stretch or shrink. Sometimes that is what you want, for instance if -you're doing indenting manual. However, usually you want a normal +you're doing manual indenting. However, usually you want a normal interword space that does stretch and shrink (in the printed output); see the `@tie' command in the next section. @@ -9001,9 +9457,9 @@ control systems. For example, to literally write $Id$ in your document, use `@w{$}Id$'. -File: texinfo.info, Node: tie, Next: sp, Prev: w, Up: Breaks +File: texinfo, Node: tie, Next: sp, Prev: w, Up: Breaks -15.5 `@tie{}': Inserting an Unbreakable Space +15.6 `@tie{}': Inserting an Unbreakable Space ============================================= The `@tie{}' command produces a normal interword space at which a line @@ -9028,9 +9484,9 @@ produces: -File: texinfo.info, Node: sp, Next: page, Prev: tie, Up: Breaks +File: texinfo, Node: sp, Next: page, Prev: tie, Up: Breaks -15.6 `@sp' N: Insert Blank Lines +15.7 `@sp' N: Insert Blank Lines ================================ A line beginning with and containing only `@sp N' generates N blank @@ -9044,9 +9500,9 @@ generates two blank lines. The `@sp' command is most often used in the title page. -File: texinfo.info, Node: page, Next: group, Prev: sp, Up: Breaks +File: texinfo, Node: page, Next: group, Prev: sp, Up: Breaks -15.7 `@page': Start a New Page +15.8 `@page': Start a New Page ============================== A line containing only `@page' starts a new page in a printed manual. @@ -9055,9 +9511,9 @@ An `@page' command is often used in the `@titlepage' section of a Texinfo file to start the copyright page. -File: texinfo.info, Node: group, Next: need, Prev: page, Up: Breaks +File: texinfo, Node: group, Next: need, Prev: page, Up: Breaks -15.8 `@group': Prevent Page Breaks +15.9 `@group': Prevent Page Breaks ================================== The `@group' command (on a line by itself) is used inside an `@example' @@ -9098,10 +9554,10 @@ It is a good rule of thumb to look for a missing `@end group' if you get incomprehensible error messages in TeX. -File: texinfo.info, Node: need, Prev: group, Up: Breaks +File: texinfo, Node: need, Prev: group, Up: Breaks -15.9 `@need MILS': Prevent Page Breaks -====================================== +15.10 `@need MILS': Prevent Page Breaks +======================================= A line containing only `@need N' starts a new page in a printed manual if fewer than N mils (thousandths of an inch) remain on the current @@ -9119,7 +9575,7 @@ the page. It looks like this: the bottoms of printed pages). -File: texinfo.info, Node: Definition Commands, Next: Conditionals, Prev: Breaks, Up: Top +File: texinfo, Node: Definition Commands, Next: Conditionals, Prev: Breaks, Up: Top 16 Definition Commands ********************** @@ -9154,7 +9610,7 @@ rather than the definition commands. * Sample Function Definition:: An example. -File: texinfo.info, Node: Def Cmd Template, Next: Def Cmd Continuation Lines, Up: Definition Commands +File: texinfo, Node: Def Cmd Template, Next: Def Cmd Continuation Lines, Up: Definition Commands 16.1 The Template for a Definition ================================== @@ -9188,7 +9644,7 @@ For example, produces -- Command: forward-word count - This function moves point forward COUNT words (or backward if + This command moves point forward COUNT words (or backward if COUNT is negative). ... Capitalize the category name like a title. If the name of the @@ -9202,7 +9658,8 @@ enclose it in braces. For example: Otherwise, the second word will be mistaken for the name of the entity. As a general rule, when any of the arguments in the heading line _except_ the last one are more than one word, you need to enclose them -in braces. +in braces. This may also be necessary if the text contains commands, +for example, `{declaraci@'on}' if you are writing in Spanish. Some of the definition commands are more general than others. The `@deffn' command, for example, is the general definition command for @@ -9223,7 +9680,7 @@ definition. expanded in `@deffn' and all the other definition commands. -File: texinfo.info, Node: Def Cmd Continuation Lines, Next: Optional Arguments, Prev: Def Cmd Template, Up: Definition Commands +File: texinfo, Node: Def Cmd Continuation Lines, Next: Optional Arguments, Prev: Def Cmd Template, Up: Definition Commands 16.2 Definition Command Continuation Lines ========================================== @@ -9272,7 +9729,7 @@ character (space, tab, newline) produces a normal interword space (*note Multiple Spaces::). -File: texinfo.info, Node: Optional Arguments, Next: deffnx, Prev: Def Cmd Continuation Lines, Up: Definition Commands +File: texinfo, Node: Optional Arguments, Next: deffnx, Prev: Def Cmd Continuation Lines, Up: Definition Commands 16.3 Optional and Repeated Arguments ==================================== @@ -9310,7 +9767,7 @@ remaining elements of the form. The function is listed in the Command and Variable Index under `foobar'. -File: texinfo.info, Node: deffnx, Next: Def Cmds in Detail, Prev: Optional Arguments, Up: Definition Commands +File: texinfo, Node: deffnx, Next: Def Cmds in Detail, Prev: Optional Arguments, Up: Definition Commands 16.4 Two or More `First' Lines ============================== @@ -9339,7 +9796,7 @@ produces The `x' forms work similarly to `@itemx' (*note itemx::). -File: texinfo.info, Node: Def Cmds in Detail, Next: Def Cmd Conventions, Prev: deffnx, Up: Definition Commands +File: texinfo, Node: Def Cmds in Detail, Next: Def Cmd Conventions, Prev: deffnx, Up: Definition Commands 16.5 The Definition Commands ============================ @@ -9365,7 +9822,7 @@ can be used for other programming languages. * Abstract Objects:: Commands for object-oriented programming. -File: texinfo.info, Node: Functions Commands, Next: Variables Commands, Up: Def Cmds in Detail +File: texinfo, Node: Functions Commands, Next: Variables Commands, Up: Def Cmds in Detail 16.5.1 Functions and Similar Entities ------------------------------------- @@ -9436,7 +9893,7 @@ entities: All these commands create entries in the index of functions. -File: texinfo.info, Node: Variables Commands, Next: Typed Functions, Prev: Functions Commands, Up: Def Cmds in Detail +File: texinfo, Node: Variables Commands, Next: Typed Functions, Prev: Functions Commands, Up: Def Cmds in Detail 16.5.2 Variables and Similar Entities ------------------------------------- @@ -9499,7 +9956,7 @@ Here are the commands for defining variables and similar entities: like `@defvar'. It creates an entry in the index of variables. -File: texinfo.info, Node: Typed Functions, Next: Typed Variables, Prev: Variables Commands, Up: Def Cmds in Detail +File: texinfo, Node: Typed Functions, Next: Typed Variables, Prev: Variables Commands, Up: Def Cmds in Detail 16.5.3 Functions in Typed Languages ----------------------------------- @@ -9586,7 +10043,7 @@ functions, such as C and C++. -File: texinfo.info, Node: Typed Variables, Next: Data Types, Prev: Typed Functions, Up: Def Cmds in Detail +File: texinfo, Node: Typed Variables, Next: Data Types, Prev: Typed Functions, Up: Def Cmds in Detail 16.5.4 Variables in Typed Languages ----------------------------------- @@ -9637,7 +10094,7 @@ specialized definition command `@deftypevar' corresponds to These commands create entries in the index of variables. -File: texinfo.info, Node: Data Types, Next: Abstract Objects, Prev: Typed Variables, Up: Def Cmds in Detail +File: texinfo, Node: Data Types, Next: Abstract Objects, Prev: Typed Variables, Up: Def Cmds in Detail 16.5.5 Data Types ----------------- @@ -9673,7 +10130,7 @@ Here is the command for data types: `@deftp' creates an entry in the index of data types. -File: texinfo.info, Node: Abstract Objects, Prev: Data Types, Up: Def Cmds in Detail +File: texinfo, Node: Abstract Objects, Prev: Data Types, Up: Def Cmds in Detail 16.5.6 Object-Oriented Programming ---------------------------------- @@ -9691,7 +10148,7 @@ its own value. * Methods: Object-Oriented Methods. -File: texinfo.info, Node: Object-Oriented Variables, Next: Object-Oriented Methods, Up: Abstract Objects +File: texinfo, Node: Object-Oriented Variables, Next: Object-Oriented Methods, Up: Abstract Objects 16.5.6.1 Object-Oriented Variables .................................. @@ -9773,7 +10230,7 @@ object-oriented programming languages. -File: texinfo.info, Node: Object-Oriented Methods, Prev: Object-Oriented Variables, Up: Abstract Objects +File: texinfo, Node: Object-Oriented Methods, Prev: Object-Oriented Variables, Up: Abstract Objects 16.5.6.2 Object-Oriented Methods ................................ @@ -9860,7 +10317,7 @@ particular classes of objects. -File: texinfo.info, Node: Def Cmd Conventions, Next: Sample Function Definition, Prev: Def Cmds in Detail, Up: Definition Commands +File: texinfo, Node: Def Cmd Conventions, Next: Sample Function Definition, Prev: Def Cmds in Detail, Up: Definition Commands 16.6 Conventions for Writing Definitions ======================================== @@ -9873,7 +10330,7 @@ type, such as INTEGER, take care that the argument actually is of that type. -File: texinfo.info, Node: Sample Function Definition, Prev: Def Cmd Conventions, Up: Definition Commands +File: texinfo, Node: Sample Function Definition, Prev: Def Cmd Conventions, Up: Definition Commands 16.7 A Sample Function Definition ================================= @@ -9882,7 +10339,7 @@ A function definition uses the `@defun' and `@end defun' commands. The name of the function follows immediately after the `@defun' command and it is followed, on the same line, by the parameter list. - Here is a definition from *Note Calling Functions: (elisp)Calling + Here is a definition from *note Calling Functions: (elisp)Calling Functions. -- Function: apply function &rest arguments @@ -9953,7 +10410,7 @@ Index under `apply'. that for functions except that variables do not take arguments. -File: texinfo.info, Node: Conditionals, Next: Internationalization, Prev: Definition Commands, Up: Top +File: texinfo, Node: Conditionals, Next: Internationalization, Prev: Definition Commands, Up: Top 17 Conditionally Visible Text ***************************** @@ -9986,7 +10443,7 @@ manual and the Info output. * Conditional Nesting:: Using conditionals inside conditionals. -File: texinfo.info, Node: Conditional Commands, Next: Conditional Not Commands, Up: Conditionals +File: texinfo, Node: Conditional Commands, Next: Conditional Not Commands, Up: Conditionals 17.1 Conditional Commands ========================= @@ -10048,7 +10505,7 @@ Notice that you only see one of the input lines, depending on which version of the manual you are reading. -File: texinfo.info, Node: Conditional Not Commands, Next: Raw Formatter Commands, Prev: Conditional Commands, Up: Conditionals +File: texinfo, Node: Conditional Not Commands, Next: Raw Formatter Commands, Prev: Conditional Commands, Up: Conditionals 17.2 Conditional Not Commands ============================= @@ -10085,7 +10542,7 @@ with `@iftex', not raw formatter source as with `@tex' (*note Raw Formatter Commands::). -File: texinfo.info, Node: Raw Formatter Commands, Next: set clear value, Prev: Conditional Not Commands, Up: Conditionals +File: texinfo, Node: Raw Formatter Commands, Next: set clear value, Prev: Conditional Not Commands, Up: Conditionals 17.3 Raw Formatter Commands =========================== @@ -10145,7 +10602,7 @@ delimit a region to be included in Docbook output only, and `@docbook still an escape character, so the `@end' command can be recognized. -File: texinfo.info, Node: set clear value, Next: Conditional Nesting, Prev: Raw Formatter Commands, Up: Conditionals +File: texinfo, Node: set clear value, Next: Conditional Nesting, Prev: Raw Formatter Commands, Up: Conditionals 17.4 `@set', `@clear', and `@value' =================================== @@ -10158,7 +10615,7 @@ commands. sections for more details: `@set FLAG [VALUE]' - Set the variable FLAG, to the optional VALUE if specifed. + Set the variable FLAG, to the optional VALUE if specified. `@clear FLAG' Undefine the variable FLAG, whether or not it was previously @@ -10181,7 +10638,7 @@ sections for more details: * value Example:: An easy way to update edition information. -File: texinfo.info, Node: set value, Next: ifset ifclear, Up: set clear value +File: texinfo, Node: set value, Next: ifset ifclear, Up: set clear value 17.4.1 `@set' and `@value' -------------------------- @@ -10243,7 +10700,7 @@ into It is a {No value for "howmuch"} wet day. -File: texinfo.info, Node: ifset ifclear, Next: value Example, Prev: set value, Up: set clear value +File: texinfo, Node: ifset ifclear, Next: value Example, Prev: set value, Up: set clear value 17.4.2 `@ifset' and `@ifclear' ------------------------------ @@ -10299,7 +10756,7 @@ and an `@end ifclear' command; rather, they ignore that text. An @ifclear FLAG -File: texinfo.info, Node: value Example, Prev: ifset ifclear, Up: set clear value +File: texinfo, Node: value Example, Prev: ifset ifclear, Up: set clear value 17.4.3 `@value' Example ----------------------- @@ -10309,7 +10766,7 @@ need to change when you record an update to a manual. *Note GNU Sample Texts::, for the full text of an example of using this to work with Automake distributions. - This example is adapted from *Note Overview: (make)Top. + This example is adapted from *note Overview: (make)Top. 1. Set the flags: @@ -10368,7 +10825,7 @@ Automake distributions. you do not need to edit the three sections. -File: texinfo.info, Node: Conditional Nesting, Prev: set clear value, Up: Conditionals +File: texinfo, Node: Conditional Nesting, Prev: set clear value, Up: Conditionals 17.5 Conditional Nesting ======================== @@ -10409,7 +10866,7 @@ the processors cannot reliably determine which commands to consider for nesting purposes. -File: texinfo.info, Node: Internationalization, Next: Defining New Texinfo Commands, Prev: Conditionals, Up: Top +File: texinfo, Node: Internationalization, Next: Defining New Texinfo Commands, Prev: Conditionals, Up: Top 18 Internationalization *********************** @@ -10418,7 +10875,7 @@ Texinfo has some support for writing in languages other than English, although this area still needs considerable work. For a list of the various accented and special characters Texinfo -supports, see *Note Inserting Accents::. +supports, see *note Inserting Accents::. * Menu: @@ -10426,124 +10883,142 @@ supports, see *Note Inserting Accents::. * documentencoding:: Declaring the input encoding. -File: texinfo.info, Node: documentlanguage, Next: documentencoding, Up: Internationalization +File: texinfo, Node: documentlanguage, Next: documentencoding, Up: Internationalization -18.1 `@documentlanguage CC': Set the Document Language -====================================================== +18.1 `@documentlanguage LL[_CC]': Set the Document Language +=========================================================== + +The `@documentlanguage' command declares the current document locale. +Write it on a line by itself, near the beginning of the file, but after +`@setfilename' (*note `@setfilename': setfilename.). + + Include a two-letter ISO 639-2 language code (LL) following the +command name, optionally followed by a two-letter ISO 3166 two-letter +country code (CC). If you have a multilingual document, the intent is +to be able to use this command multiple times, to declare each language +change. If the command is not used at all, the default is `en_US' for +US English. + + As with GNU Gettext (*note Top: (gettext)Top.), if the country code +is omitted, the main dialect is assumed where possible. For example, +`de' is equivalent to `de_DE' (German as spoken in Germany). -The `@documentlanguage' command declares the current document language. -Write it on a line by itself, with a two-letter ISO-639 language code -following (list is included below). If you have a multilingual -document, the intent is to be able to use this command multiple times, -to declare each language change. If the command is not used at all, -the default is `en' for English. - - At present, this command is ignored in Info and HTML output. For -TeX, it causes the file `txi-CC.tex' to be read (if it exists). Such a -file appropriately redefines the various English words used in TeX -output, such as `Chapter', `See', and so on. - - It would be good if this command also changed TeX's ideas of the -current hyphenation patterns (via the TeX primitive `\language'), but -this is unfortunately not currently implemented. - - Hereare the valid language codes, from ISO-639. - -`aa' Afar `ab' Abkhazian `af' Afrikaans -`am' Amharic `ar' Arabic `as' Assamese -`ay' Aymara `az' Azerbaijani `ba' Bashkir -`be' Byelorussian `bg' Bulgarian `bh' Bihari -`bi' Bislama `bn' Bengali; Bangla `bo' Tibetan -`br' Breton `ca' Catalan `co' Corsican -`cs' Czech `cy' Welsh `da' Danish -`de' German `dz' Bhutani `el' Greek -`en' English `eo' Esperanto `es' Spanish -`et' Estonian `eu' Basque `fa' Persian -`fi' Finnish `fj' Fiji `fo' Faroese -`fr' French `fy' Frisian `ga' Irish -`gd' Scots Gaelic `gl' Galician `gn' Guarani -`gu' Gujarati `ha' Hausa `he' Hebrew -`hi' Hindi `hr' Croatian `hu' Hungarian -`hy' Armenian `ia' Interlingua `id' Indonesian -`ie' Interlingue `ik' Inupiak `is' Icelandic -`it' Italian `iu' Inuktitut `ja' Japanese -`jw' Javanese `ka' Georgian `kk' Kazakh -`kl' Greenlandic `km' Cambodian `kn' Kannada -`ks' Kashmiri `ko' Korean `ku' Kurdish -`ky' Kirghiz `la' Latin `ln' Lingala -`lt' Lithuanian `lo' Laothian `lv' Latvian, Lettish -`mg' Malagasy `mi' Maori `mk' Macedonian -`ml' Malayalam `mn' Mongolian `mo' Moldavian -`mr' Marathi `ms' Malay `mt' Maltese -`my' Burmese `na' Nauru `ne' Nepali -`nl' Dutch `no' Norwegian `oc' Occitan -`om' (Afan) Oromo `or' Oriya `pa' Punjabi -`pl' Polish `ps' Pashto, Pushto `pt' Portuguese -`qu' Quechua `rm' Rhaeto-Romance `rn' Kirundi -`ro' Romanian `ru' Russian `rw' Kinyarwanda -`sa' Sanskrit `sd' Sindhi `sg' Sangro -`sh' Serbo-Croatian `si' Sinhalese `sk' Slovak -`sl' Slovenian `sm' Samoan `sn' Shona -`so' Somali `sq' Albanian `sr' Serbian -`ss' Siswati `st' Sesotho `su' Sundanese -`sv' Swedish `sw' Swahili `ta' Tamil -`te' Telugu `tg' Tajik `th' Thai -`ti' Tigrinya `tk' Turkmen `tl' Tagalog -`tn' Setswana `to' Tonga `tr' Turkish -`ts' Tsonga `tt' Tatar `tw' Twi -`ug' Uighur `uk' Ukrainian `ur' Urdu -`uz' Uzbek `vi' Vietnamese `vo' Volapuk -`wo' Wolof `xh' Xhosa `yi' Yiddish -`yo' Yoruba `za' Zhuang `zh' Chinese -`zu' Zulu - - -File: texinfo.info, Node: documentencoding, Prev: documentlanguage, Up: Internationalization + For Info and other online output, this command changes the translation +of various "document strings" such as "see" in cross-references (*note +Cross References::), "Function' in defuns (*note Definition +Commands::), and so on. Some strings, such as "Node:", "Next:", +"Menu:", etc., are keywords in Info output, so are not translated +there; they are translated in other output formats. + + For TeX, this command causes a file `txi-LOCALE.tex' to be read (if +it exists). If `@setdocumentlanguage' argument contains the optional +`_CC' suffix, this is tried first. For example, with +`@setdocumentlanguage de_DE', TeX first looks for `txi-de_DE.tex', then +`txi-de.tex'. + + Such a `txi-*' file is intended to redefine the various English words +used in TeX output, such as `Chapter', `See', and so on. We are aware +that individual words like these cannot always be translated in +isolation, and that a very different strategy would be required for +ideographic (among other) scripts. Help in improving Texinfo's +language support is welcome. + + It would also be desirable for this command to also change TeX's +ideas of the current hyphenation patterns (via the TeX primitive +`\language'), but this is unfortunately not currently implemented. + + In September 2006, the W3C Internationalization Activity released a +new recommendation for specifying tags identifying language: + `http://www.rfc-editor.org/rfc/bcp/bcp47.txt' + When Gettext supports this new scheme, Texinfo will too. + + Since the lists of language codes and country codes are quite dynamic, +we don't attempt to list them here. The valid language codes are on +the official home page for ISO 639, +`http://www.loc.gov/standards/iso639-2/'. The country codes and the +official web site for ISO 3166 can be found via +`http://en.wikipedia.org/wiki/ISO_3166'. + + +File: texinfo, Node: documentencoding, Prev: documentlanguage, Up: Internationalization 18.2 `@documentencoding ENC': Set Input Encoding ================================================ The `@documentencoding' command declares the input document encoding. Write it on a line by itself, with a valid encoding specification -following. +following, near the beginning of the file but after `@setfilename' +(*note `@setfilename': setfilename.). - At present, Texinfo supports only three encodings: + At present, Texinfo supports only these encodings: `US-ASCII' This has no particular effect, but it's included for completeness. +`UTF-8' + The vast global character encoding, expressed in 8-bit bytes. The + Texinfo processors have no deep knowledge of Unicode; for the most + part, they just pass along the input they are given to the output. + `ISO-8859-1' +`ISO-8859-15' `ISO-8859-2' - These specify the standard encodings for Western European and - Eastern European languages, respectively. A full description of - the encodings is beyond our scope here; - `http://czyborra.com/charsets/iso8859.html' is one of many useful - references. + These specify the standard encodings for Western European (the + first two) and Eastern European languages (the third), + respectively. ISO 8859-15 replaces some little-used characters + from 8859-1 (e.g., precomposed fractions) with more commonly + needed ones, such as the Euro symbol (Euro ). + + A full description of the encodings is beyond our scope here; one + useful reference is `http://czyborra.com/charsets/iso8859.html'. + +`koi8-r' + This is the commonly used encoding for the Russian language. + +`koi8-u' + This is the commonly used encoding for the Ukrainian language. + Specifying an encoding ENC has the following effects: - In Info output, if the option `--enable-encoding' is also given to + In Info output, unless the option `--disable-encoding' is given to `makeinfo', a so-called `Local Variables' section (*note File Variables: (emacs)File Variables.) is output including ENC. This -allows Info readers to set the encoding appropriately: +allows Info readers to set the encoding appropriately. Local Variables: coding: ENC End: + Also, in Info and plain text output (barring `--disable-encoding'), +accent constructs and special characters, such as `@'e', are output as +the actual 8-bit character in the given encoding. + In HTML output, a `<meta>' tag is output, in the `<head>' section of the HTML, that specifies ENC. Web servers and browsers cooperate to use this information so the correct encoding is used to display the -page. +page, if supported by the system. <meta http-equiv="Content-Type" content="text/html; charset=ENC"> - In all other cases, it is recognized but ignored. + In split HTML output, if `--transliterate-file-names' is given (*note +HTML Xref 8-bit Character Expansion::), the names of HTML files are +formed by transliteration of the corresponding node names, using the +specified encoding. + + In XML and Docbook output, the given document encoding is written in +the output file as usual with those formats. + + In TeX output, the characters which are supported in the standard +Computer Modern fonts are output accordingly. (For example, this means +using constructed accents rather than precomposed glyphs.) Using a +missing character generates a warning message, as does specifying an +unimplemented encoding. -File: texinfo.info, Node: Defining New Texinfo Commands, Next: Hardcopy, Prev: Internationalization, Up: Top +File: texinfo, Node: Defining New Texinfo Commands, Next: Hardcopy, Prev: Internationalization, Up: Top 19 Defining New Texinfo Commands ******************************** @@ -10575,7 +11050,7 @@ Texinfo provides several ways to define new commands: * definfoenclose:: Customized highlighting. -File: texinfo.info, Node: Defining Macros, Next: Invoking Macros, Up: Defining New Texinfo Commands +File: texinfo, Node: Defining Macros, Next: Invoking Macros, Up: Defining New Texinfo Commands 19.1 Defining Macros ==================== @@ -10636,7 +11111,7 @@ to undefine a macro that is already undefined. For example: @unmacro foo -File: texinfo.info, Node: Invoking Macros, Next: Macro Details, Prev: Defining Macros, Up: Defining New Texinfo Commands +File: texinfo, Node: Invoking Macros, Next: Macro Details, Prev: Defining Macros, Up: Defining New Texinfo Commands 19.2 Invoking Macros ==================== @@ -10673,13 +11148,58 @@ produces: No arguments here. - To insert a comma, brace, or backslash in an argument, prepend a -backslash, as in + Passing strings containing commas as macro arguments requires special +care, since they should be properly "quoted" to prevent `makeinfo' from +confusing them with argument separators. To manually quote a comma, +prepend it with a backslash character, like this: `\,'. Alternatively, +use the `@comma' command (*note Inserting a Comma::). However, to +facilitate use of macros, `makeinfo' implements a set of rules called +"automatic quoting": + + 1. If a macro takes only one argument, all commas in its invocation + are quoted by default. For example: + + @macro FIXME{text} + @strong{FIXME: \text\} + @end macro + + @FIXME{A nice feature, though it can be dangerous.} + + will produce the following output + + *FIXME: A nice feature, though it can be dangerous.* + + And indeed, it can. Namely, `makeinfo' does not control number of + arguments passed to one-argument macros, so be careful when you + invoke them. + + 2. If a macro invocation includes another command (including a + recursive invocation of itself), any commas in the nested command + invocation(s) are quoted by default. For example, in + + @say{@strong{Yes, I do}, person one} + + the comma after `Yes' is implicitly quoted. Here's another + example, with a recursive macro: + + @rmacro cat{a,b} + \a\\b\ + @end rmacro + + @cat{@cat{foo, bar}, baz} + + will produce the string `foobarbaz'. + + 3. Otherwise, a comma should be explicitly quoted, as above, to be + treated as a part of an argument. + + Other characters that need to be quoted in macro arguments are curly +braces and backslash. For example @MACNAME {\\\{\}\,} -which will pass the (almost certainly error-producing) argument `\{},' -to MACNAME. However, commas in parameters, even if escaped by a +will pass the (almost certainly error-producing) argument `\{},' to +MACNAME. However, commas in parameters, even if escaped by a backslash, might cause trouble in TeX. If the macro is defined to take a single argument, and is invoked @@ -10709,10 +11229,10 @@ produces: Twice: a,b & a,b. -File: texinfo.info, Node: Macro Details, Next: alias, Prev: Invoking Macros, Up: Defining New Texinfo Commands +File: texinfo, Node: Macro Details, Next: alias, Prev: Invoking Macros, Up: Defining New Texinfo Commands -19.3 Macro Details -================== +19.3 Macro Details and Caveats +============================== Due to unavoidable limitations, certain macro-related constructs cause problems with TeX. If you get macro-related errors when producing the @@ -10724,22 +11244,59 @@ texi2dvi::). * It is not advisable to redefine any TeX primitive, plain, or Texinfo command name as a macro. Unfortunately this is a very large - set of names, and the possible resulting errors are completely - random. + set of names, and the possible resulting errors are unpredictable. * All macros are expanded inside at least one TeX group. This means that `@set' and other such commands have no effect inside a macro. - * Macros containing a command which must be on a line by itself, - such as a conditional, cannot be invoked in the middle of a line. - * Commas in macro arguments, even if escaped by a backslash, don't always work. - * It is best to avoid comments inside macro definitions. - * Macro arguments cannot cross lines. + * It is (usually) best to avoid comments inside macro definitions, + but see the next item. + + * Macros containing a command which must be on a line by itself, + such as a conditional, cannot be invoked in the middle of a line. + In general, the interaction of newlines in the macro definitions + and invocations depends on the precise commands and context. You + may be able to work around some problems with judicious use of + `@c'. Suppose you define a macro that is always intended to be + used on a line by itself: + + @macro linemac + @cindex whatever + @c + @end macro + ... + foo + @linemac + bar + + Without the `@c', there will be an unwanted blank line between the + `@cindex whatever' and the `bar' (one newline comes from the macro + definition, one from after the invocation), causing a paragraph + break. + + On the other hand, you wouldn't want the `@c' if the macro was + sometimes invoked in the middle of a line (the text after the + invocation would be treated as a comment). + + * In general, you can't arbitrarily substitute a macro call for + Texinfo command arguments, even when the text is the same. It + might work with some commands, it fails with others. Best not to + do it at all. For instance, this fails: + + @macro offmacro + off + @end macro + @headings @offmacro + + You would expect this to be equivalent to `@headings off', but for + TeXnical reasons, it fails with a mysterious error message + (`Paragraph ended before @headings was complete'). + * Macros cannot define macros in the natural way. To do this, you must use conditionals and raw TeX. For example: @@ -10779,7 +11336,7 @@ ignored at the beginnings of lines. (by introducing a new macro syntax). -File: texinfo.info, Node: alias, Next: definfoenclose, Prev: Macro Details, Up: Defining New Texinfo Commands +File: texinfo, Node: alias, Next: definfoenclose, Prev: Macro Details, Up: Defining New Texinfo Commands 19.4 `@alias NEW=EXISTING' ========================== @@ -10814,7 +11371,7 @@ command name as an alias. Unfortunately this is a very large set of names, and the possible resulting errors are completely random. -File: texinfo.info, Node: definfoenclose, Prev: alias, Up: Defining New Texinfo Commands +File: texinfo, Node: definfoenclose, Prev: alias, Up: Defining New Texinfo Commands 19.5 `definfoenclose': Customized Highlighting ============================================== @@ -10841,9 +11398,9 @@ name with two commas in a row; otherwise, the Info formatting commands will naturally misinterpret the end delimiter string you intended as the start delimiter string. - If you do a `@definfoenclose' on the name of a pre-defined macro -(such as `@emph', `@strong', `@t', or `@i'), the enclosure definition -will override the built-in definition. + If you do a `@definfoenclose' on the name of a predefined macro (such +as `@emph', `@strong', `@t', or `@i'), the enclosure definition will +override the built-in definition. An enclosure command defined this way takes one argument in braces; this is intended for new markup commands (*note Marking Text::). @@ -10883,7 +11440,7 @@ argument to `@headword'. indirectly. -File: texinfo.info, Node: Hardcopy, Next: Creating and Installing Info Files, Prev: Defining New Texinfo Commands, Up: Top +File: texinfo, Node: Hardcopy, Next: Creating and Installing Info Files, Prev: Defining New Texinfo Commands, Up: Top 20 Formatting and Printing Hardcopy *********************************** @@ -10922,7 +11479,7 @@ print queue, and delete a job from the print queue. * Obtaining TeX:: How to Obtain TeX. -File: texinfo.info, Node: Use TeX, Next: Format with tex/texindex, Up: Hardcopy +File: texinfo, Node: Use TeX, Next: Format with tex/texindex, Up: Hardcopy 20.1 Use TeX ============ @@ -10938,7 +11495,7 @@ very same @-commands in the Texinfo file as does TeX, but process them differently to make an Info file (*note Creating an Info File::). -File: texinfo.info, Node: Format with tex/texindex, Next: Format with texi2dvi, Prev: Use TeX, Up: Hardcopy +File: texinfo, Node: Format with tex/texindex, Next: Format with texi2dvi, Prev: Use TeX, Up: Hardcopy 20.2 Format with `tex' and `texindex' ===================================== @@ -10954,12 +11511,11 @@ file (for "DeVice Independent" file) can be printed on virtually any device (see the following sections). The `tex' formatting command itself does not sort the indices; it -writes an output file of unsorted index data. (The `texi2dvi' command -automatically generates indices; *note Format with `texi2dvi': Format -with texi2dvi.) To generate a printed index after running the `tex' -command, you first need a sorted index to work from. The `texindex' -command sorts indices. (The source file `texindex.c' comes as part of -the standard Texinfo distribution, among other places.) +writes an output file of unsorted index data. To generate a printed +index after running the `tex' command, you first need a sorted index to +work from. The `texindex' command sorts indices. (The source file +`texindex.c' comes as part of the standard Texinfo distribution, among +other places.) (`texi2dvi' runs `tex' and `texindex' as necessary.) The `tex' formatting command outputs unsorted index files under names that obey a standard convention: the name of your main input file with @@ -11038,7 +11594,7 @@ beginning of your file would look approximately like this: `--no-validate' option (*note Pointer Validation::). -File: texinfo.info, Node: Format with texi2dvi, Next: Print with lpr, Prev: Format with tex/texindex, Up: Hardcopy +File: texinfo, Node: Format with texi2dvi, Next: Print with lpr, Prev: Format with tex/texindex, Up: Hardcopy 20.3 Format with `texi2dvi' =========================== @@ -11060,22 +11616,60 @@ perhaps in other circumstances, you may need to run `sh texi2dvi foo.texi' instead of relying on the operating system to invoke the shell on the `texi2dvi' script. - Perhaps the most useful option to `texi2dvi' is `--command=CMD'. -This inserts CMD on a line by itself after the `@setfilename' in a -temporary copy of the input file before running TeX. With this, you -can specify different printing formats, such as `@smallbook' (*note -smallbook::), `@afourpaper' (*note A4 Paper::), or `@pagesizes' (*note -pagesizes::), without actually changing the document source. (You can -also do this on a site-wide basis with `texinfo.cnf'; *note Preparing -for TeX: Preparing for TeX.). + One useful option to `texi2dvi' is `--command=CMD'. This inserts CMD +on a line by itself after the `@setfilename' in a temporary copy of the +input file before running TeX. With this, you can specify different +printing formats, such as `@smallbook' (*note smallbook::), +`@afourpaper' (*note A4 Paper::), or `@pagesizes' (*note pagesizes::), +without actually changing the document source. (You can also do this +on a site-wide basis with `texinfo.cnf'; *note Preparing for TeX: +Preparing for TeX.). + + With the `--pdf' option, `texi2dvi' produces PDF output instead of +DVI (*note PDF Output::), by running `pdftex' instead of `tex'. +Alternatively, the command `texi2pdf' is an abbreviation for running +`texi2dvi --pdf'. The command `pdftexi2dvi' is also supported as a +convenience to AUC-TeX users, since the latter merely prepends `pdf' to +DVI producing tools to have PDF producing tools. `texi2dvi' can also be used to process LaTeX files; simply run `texi2dvi filename.ext'. + Normally `texi2dvi' is able to guess the input file language by its +contents and file name suffix. If, however, it fails to do so you can +specify the input language using `--language=LANG' command line option, +where LANG is either `latex' or `texinfo'. + + `texi2dvi' will use `etex' (or `pdfetex') if they are available; +these extended versions of TeX are not required, and the DVI (or PDF) +output is identical, but they simplify the TeX programming in some +cases, and provide additional tracing information when debugging +`texinfo.tex'. + + Several options are provided for handling documents, written in +character sets other than ASCII. The `--translate-file=FILE' option +instructs `texi2dv' to translate input into internal TeX character set +using "translation file" FILE (*note TCX files: (web2c)TCX files.). + + The options `--recode' and `--recode-from=ENC' allow conversion of an +input document before running TeX. The `--recode' option recodes the +document from encoding specified by `@documentencoding' command (*note +`documentencoding': documentencoding.) to plain 7-bit `texinfo' +encoding. + + The option `--recode-from=ENC' recodes the document from ENC encoding +to the encoding specified by `@documentencoding'. This is useful, for +example, if the document is written in `UTF-8' encoding and an +equivalent 8-bit encoding is supported by `makeinfo'. + + Both `--recode' and `--recode-from=ENC' use `recode' utility to +perform the conversion. If `recode' fails to process the file, +`texi2dvi' prints a warning and continues using unmodified input file. + For a list of other options, run `texi2dvi --help'. -File: texinfo.info, Node: Print with lpr, Next: Within Emacs, Prev: Format with texi2dvi, Up: Hardcopy +File: texinfo, Node: Print with lpr, Next: Within Emacs, Prev: Format with texi2dvi, Up: Hardcopy 20.4 Shell Print Using `lpr -d' =============================== @@ -11129,7 +11723,7 @@ several alternative ways of printing DVI files: port, usually `PRN'. -File: texinfo.info, Node: Within Emacs, Next: Texinfo Mode Printing, Prev: Print with lpr, Up: Hardcopy +File: texinfo, Node: Within Emacs, Next: Texinfo Mode Printing, Prev: Print with lpr, Up: Hardcopy 20.5 From an Emacs Shell ======================== @@ -11154,7 +11748,7 @@ from a shell within Emacs: printing in Texinfo mode. -File: texinfo.info, Node: Texinfo Mode Printing, Next: Compile-Command, Prev: Within Emacs, Up: Hardcopy +File: texinfo, Node: Texinfo Mode Printing, Next: Compile-Command, Prev: Within Emacs, Up: Hardcopy 20.6 Formatting and Printing in Texinfo Mode ============================================ @@ -11253,7 +11847,7 @@ details about this. The Texinfo variables can be found in the command. -File: texinfo.info, Node: Compile-Command, Next: Requirements Summary, Prev: Texinfo Mode Printing, Up: Hardcopy +File: texinfo, Node: Compile-Command, Next: Requirements Summary, Prev: Texinfo Mode Printing, Up: Hardcopy 20.7 Using the Local Variables List =================================== @@ -11271,10 +11865,10 @@ Emacs runs the compile command. For example, at the end of the End: This technique is most often used by programmers who also compile -programs this way; see *Note Compilation: (emacs)Compilation. +programs this way; see *note Compilation: (emacs)Compilation. -File: texinfo.info, Node: Requirements Summary, Next: Preparing for TeX, Prev: Compile-Command, Up: Hardcopy +File: texinfo, Node: Requirements Summary, Next: Preparing for TeX, Prev: Compile-Command, Up: Hardcopy 20.8 TeX Formatting Requirements Summary ======================================== @@ -11304,20 +11898,20 @@ contents. (And of course most manuals contain a body of text as well.) For more information, see: - * *Note `@settitle': settitle. + * *note `@settitle': settitle. - * *Note `@setchapternewpage': setchapternewpage. + * *note `@setchapternewpage': setchapternewpage. - * *Note Page Headings: Headings. + * *note Page Headings: Headings. - * *Note Titlepage & Copyright Page::. + * *note Titlepage & Copyright Page::. - * *Note Printing Indices & Menus::. + * *note Printing Indices & Menus::. - * *Note Contents::. + * *note Contents::. -File: texinfo.info, Node: Preparing for TeX, Next: Overfull hboxes, Prev: Requirements Summary, Up: Hardcopy +File: texinfo, Node: Preparing for TeX, Next: Overfull hboxes, Prev: Requirements Summary, Up: Hardcopy 20.9 Preparing for TeX ====================== @@ -11340,8 +11934,13 @@ will find it there. from another distribution. More details are at the end of the description of the `@image' command (*note Images::). - Likewise for `pdfcolor.tex', if it is not already installed and you -use pdftex. + To be able to use quotation marks other than those used in English +you'll need to install European Computer Modern fonts and optionally +CM-Super fonts, unless they are already installed (*note Inserting +Quotation Marks::). + + If you intend to use the `@euro' command, you should install the Euro +font, if it is not already installed. *Note euro::. Optionally, you may create an additional `texinfo.cnf', and install it as well. This file is read by TeX when the `@setfilename' command @@ -11398,9 +11997,9 @@ findable by TeX: initex texinfo @dump - (`dump' is a TeX primitive.) Then, move `texinfo.fmt' to wherever -your `.fmt' files are found; typically, this will be in the -subdirectory `web2c' of your TeX installation. +(`dump' is a TeX primitive.) Then, move `texinfo.fmt' to wherever your +`.fmt' files are found; typically, this will be in the subdirectory +`web2c' of your TeX installation. ---------- Footnotes ---------- @@ -11408,7 +12007,7 @@ subdirectory `web2c' of your TeX installation. separator on these systems. -File: texinfo.info, Node: Overfull hboxes, Next: smallbook, Prev: Preparing for TeX, Up: Hardcopy +File: texinfo, Node: Overfull hboxes, Next: smallbook, Prev: Preparing for TeX, Up: Hardcopy 20.10 Overfull "hboxes" ======================= @@ -11460,7 +12059,7 @@ before the `@titlepage' command: @finalout -File: texinfo.info, Node: smallbook, Next: A4 Paper, Prev: Overfull hboxes, Up: Hardcopy +File: texinfo, Node: smallbook, Next: A4 Paper, Prev: Overfull hboxes, Up: Hardcopy 20.11 Printing "Small" Books ============================ @@ -11486,12 +12085,12 @@ end-of-header lines, the Texinfo mode TeX region formatting command, *Note small::, for information about commands that make it easier to produce examples for a smaller manual. - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing + *Note Format with texi2dvi::, and *note Preparing for TeX: Preparing for TeX, for other ways to format with `@smallbook' that do not require changing the source file. -File: texinfo.info, Node: A4 Paper, Next: pagesizes, Prev: smallbook, Up: Hardcopy +File: texinfo, Node: A4 Paper, Next: pagesizes, Prev: smallbook, Up: Hardcopy 20.12 Printing on A4 Paper ========================== @@ -11509,7 +12108,7 @@ header for this manual: @afourpaper @c %**end of header - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing + *Note Format with texi2dvi::, and *note Preparing for TeX: Preparing for TeX, for other ways to format for different paper sizes that do not require changing the source file. @@ -11517,7 +12116,7 @@ require changing the source file. `@afourlatex'. There's also `@afourwide' for A4 paper in wide format. -File: texinfo.info, Node: pagesizes, Next: Cropmarks and Magnification, Prev: A4 Paper, Up: Hardcopy +File: texinfo, Node: pagesizes, Next: Cropmarks and Magnification, Prev: A4 Paper, Up: Hardcopy 20.13 `@pagesizes' [WIDTH][, HEIGHT]: Custom Page Sizes ======================================================= @@ -11540,14 +12139,14 @@ paper (which is 250mm by 177mm for B5, 14in by 8.5in for legal). margins, you must define a new command in `texinfo.tex' (or `texinfo.cnf', *note Preparing for TeX: Preparing for TeX.). - *Note Format with texi2dvi::, and *Note Preparing for TeX: Preparing + *Note Format with texi2dvi::, and *note Preparing for TeX: Preparing for TeX, for other ways to specify `@pagesizes' that do not require changing the source file. `@pagesizes' is ignored by `makeinfo'. -File: texinfo.info, Node: Cropmarks and Magnification, Next: PDF Output, Prev: pagesizes, Up: Hardcopy +File: texinfo, Node: Cropmarks and Magnification, Next: PDF Output, Prev: pagesizes, Up: Hardcopy 20.14 Cropmarks and Magnification ================================= @@ -11596,32 +12195,46 @@ nonstandard-`\mag' may not print or may print only with certain magnifications. Be prepared to experiment. -File: texinfo.info, Node: PDF Output, Next: Obtaining TeX, Prev: Cropmarks and Magnification, Up: Hardcopy +File: texinfo, Node: PDF Output, Next: Obtaining TeX, Prev: Cropmarks and Magnification, Up: Hardcopy 20.15 PDF Output ================ -You can generate a PDF output file from Texinfo source by using the -`pdftex' program to process your file instead of plain `tex'. That is, -run `pdftex foo.texi' instead of `tex foo.texi', or give the `--pdf' -option to `texi2dvi'. +The simplest way to generate PDF output from Texinfo source is to run +the convenience script `texi2pdf' (or `pdftexi2dvi'); this simply +executes the `texi2dvi' script with the `--pdf' option (*note Format +with texi2dvi::). If for some reason you want to process the document +by hand, simply run the `pdftex' program instead of plain `tex'. That +is, run `pdftex foo.texi' instead of `tex foo.texi'. "PDF" stands for `Portable Document Format'. It was invented by Adobe Systems some years ago for document interchange, based on their -PostScript language. A PDF reader (http://www.foolabs.com/xpdf/) for -the X window system is freely available, as is the definition of the -file format (http://partners.adobe.com/asn/developer/technotes/). At -present, there are no `@ifpdf' or `@pdf' commands as with the other -output formats. +PostScript language. Related links: + + * GNU GV, a Ghostscript-based PDF reader + (http://www.foolabs.com/xpdf/). (It can also preview PostScript + documents.) + + * A freely available standalone PDF reader + (http://www.foolabs.com/xpdf/) for the X window system. + + * PDF definition + (http://partners.adobe.com/asn/acrobat/sdk/public/docs/). - Despite the `portable' in the name, PDF files are nowhere near as -portable in practice as the plain ASCII formats (Info, HTML) that -Texinfo supports (DVI portability is arguable). They also tend to be -much larger. Nevertheless, a PDF file does preserve an actual printed -document on a screen as faithfully as possible, so it has its place. + + At present, Texinfo does not provide `@ifpdf' or `@pdf' commands as +for the other output formats, since PDF documents contain many internal +links that would be hard or impossible to get right at the Texinfo +source level. + + PDF files require special software to be displayed, unlike the plain +ASCII formats (Info, HTML) that Texinfo supports. They also tend to be +much larger than the DVI files output by TeX by default. Nevertheless, +a PDF file does define an actual typeset document in a self-contained +file, so it has its place. -File: texinfo.info, Node: Obtaining TeX, Prev: PDF Output, Up: Hardcopy +File: texinfo, Node: Obtaining TeX, Prev: PDF Output, Up: Hardcopy 20.16 How to Obtain TeX ======================= @@ -11638,8 +12251,8 @@ Source Code CD-ROM suitable for printing Texinfo manuals. To order it, contact: Free Software Foundation, Inc. - 59 Temple Place Suite 330 - Boston, MA 02111-1307 + 51 Franklin St, Fifth Floor + Boston, MA 02110-1301 USA Telephone: +1-617-542-5942 Fax: (including Japan) +1-617-542-2652 @@ -11651,7 +12264,7 @@ contact: Many other TeX distributions are available; see `http://tug.org/'. -File: texinfo.info, Node: Creating and Installing Info Files, Next: Generating HTML, Prev: Hardcopy, Up: Top +File: texinfo, Node: Creating and Installing Info Files, Next: Generating HTML, Prev: Hardcopy, Up: Top 21 Creating and Installing Info Files ************************************* @@ -11665,7 +12278,7 @@ Info Files::, for general information about the file format itself. * Installing an Info File:: -File: texinfo.info, Node: Creating an Info File, Next: Installing an Info File, Up: Creating and Installing Info Files +File: texinfo, Node: Creating an Info File, Next: Installing an Info File, Up: Creating and Installing Info Files 21.1 Creating an Info File ========================== @@ -11693,7 +12306,7 @@ Installing an Info File::. to run better. -File: texinfo.info, Node: makeinfo advantages, Next: Invoking makeinfo, Up: Creating an Info File +File: texinfo, Node: makeinfo advantages, Next: Invoking makeinfo, Up: Creating an Info File 21.1.1 `makeinfo' Preferred --------------------------- @@ -11712,7 +12325,7 @@ are useful if you cannot run `makeinfo'. Also, in some circumstances, they format short regions or buffers more quickly than `makeinfo'. -File: texinfo.info, Node: Invoking makeinfo, Next: makeinfo options, Prev: makeinfo advantages, Up: Creating an Info File +File: texinfo, Node: Invoking makeinfo, Next: makeinfo options, Prev: makeinfo advantages, Up: Creating an Info File 21.1.2 Running `makeinfo' from a Shell -------------------------------------- @@ -11729,7 +12342,7 @@ Bison, type the following to the shell: the next section. -File: texinfo.info, Node: makeinfo options, Next: Pointer Validation, Prev: Invoking makeinfo, Up: Creating an Info File +File: texinfo, Node: makeinfo options, Next: Pointer Validation, Prev: Invoking makeinfo, Up: Creating an Info File 21.1.3 Options for `makeinfo' ----------------------------- @@ -11773,13 +12386,27 @@ and would also set the fill column to 70. sheets specifications, in the `<style>' block of the HTML output. *Note HTML CSS::. If FILE is `-', read standard input. +`--css-ref=URL' + In HTML mode, add a `<link>' tag to the HTML output which + references a cascading style sheet at URL. This allows using + standalone style sheets. + +`--disable-encoding' +`--enable-encoding' + By default, or with `--enable-encoding', output accented and + special characters in Info or plain text output based on + `@documentencoding'. With `--disable-encoding', 7-bit ASCII + transliterations are output. *Note `documentencoding': + documentencoding, and *note Inserting Accents::. + `--docbook' Generate Docbook output rather than Info. -`--enable-encoding' - Output accented and special characters in Info or plain text output - based on `@documentencoding'. *Note `documentencoding': - documentencoding, and *Note Inserting Accents::. +`--document-language=LANG' + Use LANG to translate Texinfo keywords which end up in the output + document. The default is the locale specified by the + `@documentlanguage' command if there is one (*note + documentlanguage::). `--error-limit=LIMIT' `-e LIMIT' @@ -11840,8 +12467,7 @@ and would also set the fill column to 70. For the specified format, process `@ifFORMAT' and `@FORMAT' commands even if not generating the given output format. For instance, if `--iftex' is specified, then `@iftex' and `@tex' - blocks will be read. This can be useful when postprocessing the - output. + blocks will be read. `--macro-expand=FILE' `-E FILE' @@ -11851,11 +12477,13 @@ and would also set the fill column to 70. by `texi2dvi'. `--no-headers' - For Info output, do not include menus or node separator lines in - the output, and implicitly `--enable-encoding' (see above). This - results in a simple plain text file that you can (for example) - send in email without complications, or include in a distribution - (as in an `INSTALL' file). + +`--plaintext' + Do not include menus or node separator lines in the output, and + implicitly `--enable-encoding' (see above). This results in a + simple plain text file that you can (for example) send in email + without complications, or include in a distribution (as in an + `INSTALL' file). For HTML output, likewise omit menus. And if `--no-split' is also specified, do not include a navigation links at the top of each @@ -11871,9 +12499,19 @@ and would also set the fill column to 70. `--no-ifplaintext' `--no-iftex' `--no-ifxml' - Do not process `@ifFORMAT' and `@FORMAT' commands even if - generating the given format. For instance, if `--no-ifhtml' is - specified, then `@ifhtml' and `@html' blocks will not be read. + Do not process `@ifFORMAT' and `@FORMAT' commands, and do process + `@ifnotFORMAT', even if generating the given format. For + instance, if `--no-ifhtml' is specified, then `@ifhtml' and + `@html' blocks will not be read, and `@ifnothtml' blocks will be. + +`--no-number-footnotes' + Suppress automatic footnote numbering. By default, `makeinfo' + numbers each footnote sequentially in a single node, resetting the + current footnote number to 1 at the start of each node. + +`--no-number-sections' + Do not output chapter, section, and appendix numbers. You need to + specify this if your manual is not hierarchically-structured. `--no-split' Suppress the splitting stage of `makeinfo'. By default, large @@ -11884,26 +12522,19 @@ and would also set the fill column to 70. `--no-pointer-validate' `--no-validate' - Suppress the pointer-validation phase of `makeinfo'. This can also - be done with the `@novalidate' command (*note Use TeX: Use TeX.). - Normally, after a Texinfo file is processed, some consistency - checks are made to ensure that cross references can be resolved, - etc. *Note Pointer Validation::. + Suppress the pointer-validation phase of `makeinfo'--a dangerous + thing to do. This can also be done with the `@novalidate' command + (*note Use TeX: Use TeX.). Normally, after a Texinfo file is + processed, some consistency checks are made to ensure that cross + references can be resolved, etc. *Note Pointer Validation::. `--no-warn' - Suppress warning messages (but _not_ error messages). You might - want this if the file you are creating has examples of Texinfo - cross references within it, and the nodes that are referenced do - not actually exist. + Suppress warning messages (but _not_ error messages). `--number-sections' Output chapter, section, and appendix numbers as in printed - manuals. - -`--no-number-footnotes' - Suppress automatic footnote numbering. By default, `makeinfo' - numbers each footnote sequentially in a single node, resetting the - current footnote number to 1 at the start of each node. + manuals. This is the default. It works only with + hierarchically-structured manuals. `--output=FILE' `-o FILE' @@ -11935,16 +12566,14 @@ and would also set the fill column to 70. NUM Indent each paragraph by NUM spaces. -`--reference-limit=LIMIT' -`-r LIMIT' - Set the value of the number of references to a node that - `makeinfo' will make without reporting a warning. If a node has - more than this number of references in it, `makeinfo' will make the - references but also report a warning. The default is 1000. - `--split-size=NUM' Keep Info files to at most NUM characters; default is 300,000. +`--transliterate-file-names' + Enable transliteration of 8-bit characters in node names for the + purpose of file name creation. *Note HTML Xref 8-bit Character + Expansion::. + `-U VAR' Cause VAR to be undefined. This is equivalent to `@clear VAR' in the Texinfo file (*note set clear value::). @@ -11971,7 +12600,7 @@ overridden by a command line option. The possible values are: If not set, Info output is the default. -File: texinfo.info, Node: Pointer Validation, Next: makeinfo in Emacs, Prev: makeinfo options, Up: Creating an Info File +File: texinfo, Node: Pointer Validation, Next: makeinfo in Emacs, Prev: makeinfo options, Up: Creating an Info File 21.1.4 Pointer Validation ------------------------- @@ -12008,8 +12637,8 @@ exist. Here is a complete list of what is checked: Some Texinfo documents might fail during the validation phase because they use commands like `@value' and `@definfoenclose' in node -definitions and cross-references inconsistently. Consider the -following example: +definitions and cross-references inconsistently. (Your best bet is to +avoid using @-commands in node names.) Consider the following example: @set nodename Node 1 @@ -12045,7 +12674,7 @@ it, even if invoked with the `--commands-in-node-names' option. option is given. -File: texinfo.info, Node: makeinfo in Emacs, Next: texinfo-format commands, Prev: Pointer Validation, Up: Creating an Info File +File: texinfo, Node: makeinfo in Emacs, Next: texinfo-format commands, Prev: Pointer Validation, Up: Creating an Info File 21.1.5 Running `makeinfo' Within Emacs -------------------------------------- @@ -12104,13 +12733,13 @@ initialization file. --fill-column=70 --verbose") For more information, see -*Note Easy Customization Interface: (emacs)Easy Customization, -*Note Examining and Setting Variables: (emacs)Examining, -*Note Init File: (emacs)Init File, and -*Note Options for `makeinfo': makeinfo options. +*note Easy Customization Interface: (emacs)Easy Customization, +*note Examining and Setting Variables: (emacs)Examining, +*note Init File: (emacs)Init File, and +*note Options for `makeinfo': makeinfo options. -File: texinfo.info, Node: texinfo-format commands, Next: Batch Formatting, Prev: makeinfo in Emacs, Up: Creating an Info File +File: texinfo, Node: texinfo-format commands, Next: Batch Formatting, Prev: makeinfo in Emacs, Up: Creating an Info File 21.1.6 The `texinfo-format...' Commands --------------------------------------- @@ -12137,12 +12766,12 @@ of the Texinfo file. The `texinfo-format-region' and `texinfo-format-buffer' commands provide you with some error checking, and other functions can provide you with further help in finding formatting errors. These procedures -are described in an appendix; see *Note Catching Mistakes::. However, +are described in an appendix; see *note Catching Mistakes::. However, the `makeinfo' program is often faster and provides better error checking (*note makeinfo in Emacs::). -File: texinfo.info, Node: Batch Formatting, Next: Tag and Split Files, Prev: texinfo-format commands, Up: Creating an Info File +File: texinfo, Node: Batch Formatting, Next: Tag and Split Files, Prev: texinfo-format commands, Up: Creating an Info File 21.1.7 Batch Formatting ----------------------- @@ -12171,7 +12800,7 @@ continue working in it. (When you run `texinfo-format-region' or until the command finishes.) -File: texinfo.info, Node: Tag and Split Files, Prev: Batch Formatting, Up: Creating an Info File +File: texinfo, Node: Tag and Split Files, Prev: Batch Formatting, Up: Creating an Info File 21.1.8 Tag Files and Split Files -------------------------------- @@ -12244,11 +12873,11 @@ may want to run the `Info-validate' command. (The `makeinfo' command does such a good job on its own, you do not need `Info-validate'.) However, you cannot run the `M-x Info-validate' node-checking command on indirect files. For information on how to prevent files from being -split and how to validate the structure of the nodes, see *Note Using +split and how to validate the structure of the nodes, see *note Using Info-validate::. -File: texinfo.info, Node: Installing an Info File, Prev: Creating an Info File, Up: Creating and Installing Info Files +File: texinfo, Node: Installing an Info File, Prev: Creating an Info File, Up: Creating and Installing Info Files 21.2 Installing an Info File ============================ @@ -12268,7 +12897,7 @@ Emacs. (*note info: (info)Top, for an introduction to Info.) * Invoking install-info:: `install-info' options. -File: texinfo.info, Node: Directory File, Next: New Info File, Up: Installing an Info File +File: texinfo, Node: Directory File, Next: New Info File, Up: Installing an Info File 21.2.1 The Directory File `dir' ------------------------------- @@ -12310,7 +12939,7 @@ can be written in either upper or lower case. This is not true in general, it is a special case for `dir'. -File: texinfo.info, Node: New Info File, Next: Other Info Directories, Prev: Directory File, Up: Installing an Info File +File: texinfo, Node: New Info File, Next: Other Info Directories, Prev: Directory File, Up: Installing an Info File 21.2.2 Listing a New Info File ------------------------------ @@ -12339,7 +12968,7 @@ use just `gdb' for the file name, not `gdb.info'. as well. -File: texinfo.info, Node: Other Info Directories, Next: Installing Dir Entries, Prev: New Info File, Up: Installing an Info File +File: texinfo, Node: Other Info Directories, Next: Installing Dir Entries, Prev: New Info File, Up: Installing an Info File 21.2.3 Info Files in Other Directories -------------------------------------- @@ -12443,7 +13072,7 @@ syntax for using values of other environment variables. (2) On MS-DOS/MS-Windows systems, use semi-colon instead. -File: texinfo.info, Node: Installing Dir Entries, Next: Invoking install-info, Prev: Other Info Directories, Up: Installing an Info File +File: texinfo, Node: Installing Dir Entries, Next: Invoking install-info, Prev: Other Info Directories, Up: Installing an Info File 21.2.4 Installing Info Directory Files -------------------------------------- @@ -12483,6 +13112,15 @@ is how it knows what to do. beginning of the Texinfo input, before the first `@node' command. If you use them later on in the input, `install-info' will not notice them. + `install-info' will automatically reformat the description of the +menu entries it is adding. As a matter of convention, the description +of the main entry (above, `The GNU documentation format') should start +at column 32, starting at zero (as in `what-cursor-position' in Emacs). +This will make it align with most others. Description for individual +utilities best start in column 48, where possible. For more +information about formatting see the `--calign', `--align', and +`--max-width' options in *note Invoking install-info::. + If you use `@dircategory' more than once in the Texinfo source, each usage specifies the `current' category; any subsequent `@direntry' commands will add to that category. @@ -12510,16 +13148,17 @@ documentation for the different programs they can run, as with the traditional `man' system. -File: texinfo.info, Node: Invoking install-info, Prev: Installing Dir Entries, Up: Installing an Info File +File: texinfo, Node: Invoking install-info, Prev: Installing Dir Entries, Up: Installing an Info File 21.2.5 Invoking `install-info' ------------------------------ `install-info' inserts menu entries from an Info file into the top-level `dir' file in the Info system (see the previous sections for -an explanation of how the `dir' file works). It's most often run as -part of software installation, or when constructing a `dir' file for -all manuals on a system. Synopsis: +an explanation of how the `dir' file works). `install-info' also +removes menu entries from the `dir' file. It's most often run as part +of software installation, or when constructing a `dir' file for all +manuals on a system. Synopsis: install-info [OPTION]... [INFO-FILE [DIR-FILE]] @@ -12540,18 +13179,50 @@ DIR-FILE itself does not exist, `install-info' tries to open Options: +`--add-once' + Specifies that the entry or entries will only be put into a single + section. + +`--align=COLUMN' + Specifies the column that the second and subsequent lines of menu + entry's description will be formatted to begin at. The default + for this option is `35'. It is used in conjunction with the + `--max-width' option. COLUMN starts counting at 1. + +`--append-new-sections' + Instead of alphabetizing new sections, place them at the end of + the DIR file. + +`--calign=COLUMN' + Specifies the column that the first line of menu entry's + description will be formatted to begin at. The default for this + option is `33'. It is used in conjunction with the `--max-width' + option. When the name of the menu entry exceeds this column, + entry's description will start on the following line. COLUMN + starts counting at 1. + +`--debug' + Report what is being done. + `--delete' Delete the entries in INFO-FILE from DIR-FILE. The file name in the entry in DIR-FILE must be INFO-FILE (except for an optional - `.info' in either one). Don't insert any new entries. + `.info' in either one). Don't insert any new entries. Any empty + sections that result from the removal are also removed. + +`--description=TEXT' + Specify the explanatory portion of the menu entry. If you don't + specify a description (either via `--entry', `--item' or this + option), the description is taken from the Info file itself. `--dir-file=NAME' -`-d NAME' Specify file name of the Info directory file. This is equivalent to using the DIR-FILE argument. +`--dry-run' + Same as `--test'. + `--entry=TEXT' -`-e TEXT' Insert TEXT as an Info directory entry; TEXT should have the form of an Info menu item line plus zero or more extra lines starting with whitespace. If you specify more than one entry, they are all @@ -12559,45 +13230,104 @@ DIR-FILE itself does not exist, `install-info' tries to open information in the Info file itself. `--help' -`-h' - Display a usage message listing basic usage and all available - options, then exit successfully. + Display a usage message with basic usage and all available options, + then exit successfully. `--info-file=FILE' -`-i FILE' - Specify Info file to install in the directory. Equivalent to - using the INFO-FILE argument. + Specify Info file to install in the directory. This is equivalent + to using the INFO-FILE argument. `--info-dir=DIR' -`-D DIR' Specify the directory where the directory file `dir' resides. Equivalent to `--dir-file=DIR/dir'. +`--infodir=DIR' + Same as `--info-dir'. + `--item=TEXT' Same as `--entry=TEXT'. An Info directory entry is actually a menu item. +`--keep-old' + Do not replace pre-existing menu entries. When `--remove' is + specified, this option means that empty sections are not removed. + +`--max-width=COLUMN' + Specifies the column that the menu entry's description will be + word-wrapped at. COLUMN starts counting at 1. + +`--maxwidth=COLUMN' + Same as `--max-width'. + +`--menuentry=TEXT' + Same as `--name'. + +`--name=TEXT' + Specify the name portion of the menu entry. If the TEXT does not + start with an asterisk `*', it is presumed to be the text after + the `*' and before the parentheses that specify the Info file. + Otherwise TEXT is taken verbatim, and is meant to include the text + up to and including the first dot `.'. If you don't specify the + name (either via `--entry', `--item' or this option), it is taken + from the Info file itself. If the Info does not contain the name, + the basename of the Info file is used. + +`--no-indent' + Suppress formatting of new entries into the `dir' file. + `--quiet' - Suppress warnings. +`--silent' + Suppress warnings, etc., for silent operation. `--remove' -`-r' Same as `--delete'. +`--remove-exactly' + Also like `--delete', but only entries if the Info file name + matches exactly; `.info' and/or `.gz' suffixes are _not_ ignored. + `--section=SEC' -`-s SEC' Put this file's entries in section SEC of the directory. If you specify more than one section, all the entries are added in each of the sections. If you don't specify any sections, they are - determined from information in the Info file itself. + determined from information in the Info file itself. If the Info + file doesn't specify a section, the menu entries are put into the + Miscellaneous section. + +`--section REGEX SEC' + Same as `--regex=REGEX --section=SEC --add-once'. + + `install-info' tries to detect when this alternate syntax is used, + but does not always guess correctly! Here is the heuristic that + `install-info' uses: + 1. If the second argument to `--section' starts with a hyphen, + the original syntax is presumed. + + 2. If the second argument to `--section' is a file that can be + opened, the original syntax is presumed + + 3. Otherwise the alternate syntax is used. + + When heuristic fails because your section title starts with a + hyphen, or it happens to be a filename that can be opened, the + syntax should be changed to `--regex=REGEX --section=SEC + --add-once'. + +`--regex=REGEX' + Put this file's entries into any section that matches REGEX. If + more than one section matches, all of the entries are added in + each of the sections. Specify REGEX using basic regular + expression syntax, more or less as used with `grep', for example. + +`--test' + Suppress updating of the directory file. `--version' -`-V' Display version information and exit successfully. -File: texinfo.info, Node: Generating HTML, Next: Command List, Prev: Creating and Installing Info Files, Up: Top +File: texinfo, Node: Generating HTML, Next: Command List, Prev: Creating and Installing Info Files, Up: Top 22 Generating HTML ****************** @@ -12618,7 +13348,7 @@ overview of all the output formats. * HTML Xref:: Cross-references in HTML output. -File: texinfo.info, Node: HTML Translation, Next: HTML Splitting, Up: Generating HTML +File: texinfo, Node: HTML Translation, Next: HTML Splitting, Up: Generating HTML 22.1 HTML Translation ===================== @@ -12648,7 +13378,7 @@ error-free run of `makeinfo' which has browser portability problems as a bug.) -File: texinfo.info, Node: HTML Splitting, Next: HTML CSS, Prev: HTML Translation, Up: Generating HTML +File: texinfo, Node: HTML Splitting, Next: HTML CSS, Prev: HTML Translation, Up: Generating HTML 22.2 HTML Splitting =================== @@ -12688,7 +13418,7 @@ named `index.html'. (the argument is used literally). -File: texinfo.info, Node: HTML CSS, Next: HTML Xref, Prev: HTML Splitting, Up: Generating HTML +File: texinfo, Node: HTML CSS, Next: HTML Xref, Prev: HTML Splitting, Up: Generating HTML 22.3 HTML CSS ============= @@ -12711,11 +13441,16 @@ use the `inherited' font (generally a regular roman typeface) for both `@smalldisplay' and `@display'. By default, the HTML `<pre>' command uses a monospaced font. - You can influence the CSS in the HTML output with the -`--css-include=FILE' option to `makeinfo'. This includes the contents -FILE in the HTML output, as you might expect. However, the details are -somewhat tricky, as described in the following, to provide maximum -flexibility. + You can influence the CSS in the HTML output with two `makeinfo' +options: `--css-include=FILE' and `--css-ref=URL'. + + The option `--css-ref=URL' adds to each output HTML file a `<link>' +tag referencing a CSS at the given URL. This allows using external +style sheets. + + The option `--css-include=FILE' includes the contents FILE in the +HTML output, as you might expect. However, the details are somewhat +tricky, as described in the following, to provide maximum flexibility. The CSS file may begin with so-called `@import' directives, which link to external CSS specifications for browsers to use when @@ -12765,7 +13500,7 @@ characters and blindly copies the text into the output. Comments in the CSS file may or may not be included in the output. -File: texinfo.info, Node: HTML Xref, Prev: HTML CSS, Up: Generating HTML +File: texinfo, Node: HTML Xref, Prev: HTML CSS, Up: Generating HTML 22.4 HTML Cross-references ========================== @@ -12797,7 +13532,7 @@ in 2003-04. * Mismatch: HTML Xref Mismatch. -File: texinfo.info, Node: HTML Xref Link Basics, Next: HTML Xref Node Name Expansion, Up: HTML Xref +File: texinfo, Node: HTML Xref Link Basics, Next: HTML Xref Node Name Expansion, Up: HTML Xref 22.4.1 HTML Cross-reference Link Basics --------------------------------------- @@ -12823,9 +13558,9 @@ the `http://localhost/' could be omitted entirely. The DIR and FILE parts are more complicated, and depend on the relative split/mono nature of both the manual being processed and the manual that the cross-reference refers to. The underlying idea is that -there is one directory for Texinfo manuals in HTML, and each manual is -either available as a monolithic file `manual.html', or a split -subdirectory `manual/*.html'. Here are the cases: +there is one directory for Texinfo manuals in HTML, and a given MANUAL +is either available as a monolithic file `MANUAL.html', or a split +subdirectory `MANUAL/*.html'. Here are the cases: * If the present manual is split, and the referent manual is also split, the directory is `../REFERENT/' and the file is the @@ -12843,6 +13578,11 @@ subdirectory `manual/*.html'. Here are the cases: file is `REFERENT.html'. + One exception: the algorithm for node name expansion prefixes the +string `g_t' when the node name begins with a non-letter. This kludge +(due to XHTML rules) is not necessary for filenames, and is therefore +omitted. + Any directory part in the filename argument of the source cross-reference command is ignored. Thus, `@xref{,,,../foo}' and `@xref{,,,foo}' both use `foo' as the manual name. This is because any @@ -12864,16 +13604,18 @@ the generating software assumes, and the format it's actually present in. *Note HTML Xref Mismatch::. -File: texinfo.info, Node: HTML Xref Node Name Expansion, Next: HTML Xref Command Expansion, Prev: HTML Xref Link Basics, Up: HTML Xref +File: texinfo, Node: HTML Xref Node Name Expansion, Next: HTML Xref Command Expansion, Prev: HTML Xref Link Basics, Up: HTML Xref 22.4.2 HTML Cross-reference Node Name Expansion ----------------------------------------------- As mentioned in the previous section, the key part of the HTML cross-reference algorithm is the conversion of node names in the -Texinfo source into strings suitable for HTML identifiers and +Texinfo source into strings suitable for XHTML identifiers and filenames. The restrictions are similar for each: plain ASCII letters, numbers, and the `-' and `_' characters are all that can be used. +(Although HTML anchors can contain most characters, XHTML is more +restrictive.) Cross-references in Texinfo can actually refer either to nodes or anchors (*note anchor::), but anchors are treated identically to nodes @@ -12885,26 +13627,37 @@ in this context, so we'll continue to say "node" names for simplicity. A special exception: the Top node (*note The Top Node::) is always mapped to the file `index.html', to match web server software. However, the HTML _target_ is `Top'. Thus (in the split case): + @xref{Top, Introduction,, emacs, The GNU Emacs Manual}. => <a href="emacs/index.html#Top"> - 1. The standard ASCII letters (a-z and A-z), and numbers (0-9) are not - modified. All other characters are changed as specified below. + 1. The standard ASCII letters (a-z and A-Z) are not modified. All + other characters are changed as specified below. - 2. Multiple consecutive space, tab and newline characters are + 2. The standard ASCII numbers (0-9) are not modified except when a + number is the first character of the node name. In that case, see + below. + + 3. Multiple consecutive space, tab and newline characters are transformed into just one space. (It's not possible to have newlines in node names with the current implementation, but we specify it anyway, just in case.) - 3. Leading and trailing spaces are removed. + 4. Leading and trailing spaces are removed. - 4. After the above has been applied, each remaining space character is + 5. After the above has been applied, each remaining space character is converted into a `-' character. - 5. Other ASCII 7-bit characters are transformed into `_00XX', where + 6. Other ASCII 7-bit characters are transformed into `_00XX', where XX is the ASCII character code in (lowercase) hexadecimal. This includes `_', which is mapped to `_005f'. + 7. If the node name does not begin with a letter, the literal string + `g_t' is prefixed to the result. (Due to the rules above, that + string can never occur otherwise; it is an arbitrary choice, + standing for "GNU Texinfo".) This is necessary because XHTML + requires that identifiers begin with a letter. + For example: @@ -12930,7 +13683,7 @@ mapped to the same file. target names are always case-sensitive, independent of operating system. -File: texinfo.info, Node: HTML Xref Command Expansion, Next: HTML Xref 8-bit Character Expansion, Prev: HTML Xref Node Name Expansion, Up: HTML Xref +File: texinfo, Node: HTML Xref Command Expansion, Next: HTML Xref 8-bit Character Expansion, Prev: HTML Xref Node Name Expansion, Up: HTML Xref 22.4.3 HTML Cross-reference Command Expansion --------------------------------------------- @@ -12952,7 +13705,7 @@ completeness. removed, the text of the argument is recursively transformed: @asis @b @cite @code @command @dfn @dmn @dotless @emph @env @file @indicateurl @kbd @key - @samp @sc @strong @t @var @w + @samp @sc @slanted @strong @t @var @w For `@sc', any letters are capitalized. @@ -12986,21 +13739,23 @@ other rules. `@enddots' `...' `@equiv' U+2261 `@error' `error-->' +`@euro' U+20AC `@exclamdown' U+00A1 `@expansion' U+2192 `@minus' U+2212 `@ordf' U+00AA `@ordm' U+00BA -`@point' U+2217 +`@point' U+2605 `@pounds' U+00A3 -`@print' `-|' +`@print' U+22A3 `@questiondown' U+00BF `@registeredsymbol' U+00AE `@result' U+21D2 `@tie' (space) - An `@acronym' command is replaced by the first argument, followed by -the second argument in parentheses, if present. *Note acronym::. + An `@acronym' or `@abbr' command is replaced by the first argument, +followed by the second argument in parentheses, if present. *Note +acronym::. An `@email' command is replaced by the TEXT argument if present, else the address. *Note email::. @@ -13014,15 +13769,16 @@ verb::. Any other command is an error, and the result is unspecified. -File: texinfo.info, Node: HTML Xref 8-bit Character Expansion, Next: HTML Xref Mismatch, Prev: HTML Xref Command Expansion, Up: HTML Xref +File: texinfo, Node: HTML Xref 8-bit Character Expansion, Next: HTML Xref Mismatch, Prev: HTML Xref Command Expansion, Up: HTML Xref 22.4.4 HTML Cross-reference 8-bit Character Expansion ----------------------------------------------------- -Characters other than plain 7-bit ASCII are transformed into the -corresponding Unicode code point(s), in Normalization Form C, which +Usually, characters other than plain 7-bit ASCII are transformed into +the corresponding Unicode code point(s) in Normalization Form C, which uses precomposed characters where available. (This is the -normalization form recommended by the W3C and other bodies.) +normalization form recommended by the W3C and other bodies.) This +holds when that code point is 0xffff or less, as it almost always is. These will then be further transformed by the rules above into the string `_XXXX', where XXXX is the code point in hex. @@ -13037,12 +13793,31 @@ to three `_002e''s; 2) `@u{B}' is a `B' with a breve accent, which does not exist as a pre-accented Unicode character, therefore expands to `B_0306' (B with combining breve). + When the Unicode code point is above 0xffff, the transformation is +`__XXXXXX', that is, two leading underscores followed by six hex +digits. Since Unicode has declared that their highest code point is +0x10ffff, this is sufficient. (We felt it was better to define this +extra escape than to always use six hex digits, since the first two +would nearly always be zeros.) + + This method works fine if the node name consists mostly of ASCII +characters and contains only few 8-bit ones. If the document is written +in a language whose script is not based on the Latin alphabet (such as, +e.g. Ukrainian), it will create file names consisting entirely of +`_XXXX' notations, which is inconvenient. + + To handle such cases, `makeinfo' offers `--transliterate-file-names' +command line option. This option enables "transliteration" of node +names into ASCII characters for the purposes of file name creation and +referencing. The transliteration is based on phonetic principle, which +makes the produced file names easily readable. + For the definition of Unicode Normalization Form C, see Unicode report UAX#15, `http://www.unicode.org/reports/tr15/'. Many related documents and implementations are available elsewhere on the web. -File: texinfo.info, Node: HTML Xref Mismatch, Prev: HTML Xref 8-bit Character Expansion, Up: HTML Xref +File: texinfo, Node: HTML Xref Mismatch, Prev: HTML Xref 8-bit Character Expansion, Up: HTML Xref 22.4.5 HTML Cross-reference Mismatch ------------------------------------ @@ -13087,7 +13862,7 @@ generating the actual cross-reference in the present manual can control. control which manuals are available from where, and how. -File: texinfo.info, Node: Command List, Next: Tips, Prev: Generating HTML, Up: Top +File: texinfo, Node: Command List, Next: Tips, Prev: Generating HTML, Up: Top Appendix A @-Command List ************************* @@ -13137,11 +13912,9 @@ given in the section below. Produces no output, but allows a line break. *Note Line Breaks::. `@:' - Indicate to TeX that an immediately preceding period, question - mark, exclamation mark, or colon does not end a sentence. Prevent - TeX from inserting extra whitespace as it does at the end of a - sentence. The command has no effect on the Info file output. - *Note Not Ending a Sentence::. + Tell TeX to refrain from inserting extra whitespace after an + immediately preceding period, question mark, exclamation mark, or + colon, as TeX normally would. *Note Not Ending a Sentence::. `@=' Generate a macron (bar) accent over the next character, as in o=. @@ -13181,9 +13954,13 @@ given in the section below. Generate the uppercase and lowercase Scandinavian A-ring letters, respectively: AA, aa. *Note Inserting Accents::. -`@acronym{ABBREV}' - Tag ABBREV as an acronym, that is, an abbreviation written in all - capital letters, such as `NASA'. *Note `acronym': acronym. +`@abbr{ABBREVIATION}' + Tag ABBREVIATION as an abbreviation, such as `Comput.'. *Note + `abbr': abbr. + +`@acronym{ACRONYM}' + Tag ACRONYM as an acronym, such as `NASA'. *Note `acronym': + acronym. `@AE{}' `@ae{}' @@ -13232,10 +14009,14 @@ given in the section below. Info, the title is underlined with periods. *Note The `subsub' Commands: subsubsection. +`@arrow{}' + Produce a normal right arrow glyph: `->'. Used by default for + `@click'. *Note Click Sequences::. + `@asis' Used following `@table', `@ftable', and `@vtable' to print the - table's first column without highlighting ("as is"). *Note Making - a Two-column Table: Two-column Tables. + table's first column without highlighting ("as is"). *Note + Two-column Tables::. `@author AUTHOR' Typeset AUTHOR flushleft and underline it. *Note The `@title' and @@ -13293,6 +14074,18 @@ given in the section below. Highlight the name of a book or other reference that lacks a companion Info file. *Note `@cite': cite. +`@click{}' + Represent a single "click" in a GUI. Used within + `@clicksequence'. *Note Click Sequences::. + +`@clicksequence{ACTION @click{} ACTION}' + Represent a sequence of clicks in a GUI. *Note Click Sequences::. + +`@clickstyle @CMD' + Execute @CMD for each `@click'; the default is `@arrow'. The + usual following empty braces on @CMD are omitted. *Note Click + Sequences::. + `@clear FLAG' Unset FLAG, preventing the Texinfo formatting commands from formatting text between subsequent pairs of `@ifset FLAG' and @@ -13335,7 +14128,7 @@ given in the section below. Format a description for a variable associated with a class in object-oriented programming. Takes three arguments: the category of thing being defined, the class to which it belongs, and its - name. *Note Definition Commands::, and *Note Def Cmds in Detail: + name. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@deffn CATEGORY NAME ARGUMENTS...' @@ -13359,13 +14152,13 @@ given in the section below. `@defivarx CLASS INSTANCE-VARIABLE-NAME' This command formats a description for an instance variable in object-oriented programming. The command is equivalent to `@defcv - {Instance Variable} ...'. *Note Definition Commands::, and *Note + {Instance Variable} ...'. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@defmac MACRONAME ARGUMENTS...' `@defmacx MACRONAME ARGUMENTS...' Format a description for a macro. The command is equivalent to - `@deffn Macro ...'. *Note Definition Commands::, and *Note Def + `@deffn Macro ...'. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@defmethod CLASS METHOD-NAME ARGUMENTS...' @@ -13374,7 +14167,7 @@ given in the section below. The command is equivalent to `@defop Method ...'. Takes as arguments the name of the class of the method, the name of the method, and its arguments, if any. *Note Definition Commands::, - and *Note Def Cmds in Detail: deffnx. + and *note Def Cmds in Detail: deffnx. `@defop CATEGORY CLASS NAME ARGUMENTS...' `@defopx CATEGORY CLASS NAME ARGUMENTS...' @@ -13382,31 +14175,31 @@ given in the section below. programming. `@defop' takes as arguments the overall name of the category of operation, the name of the class of the operation, the name of the operation, and its arguments, if any. *Note - Definition Commands::, and *Note Abstract Objects::. + Definition Commands::, and *note Abstract Objects::. `@defopt OPTION-NAME' `@defoptx OPTION-NAME' Format a description for a user option. The command is equivalent to `@defvr {User Option} ...'. *Note Definition Commands::, and - *Note Def Cmds in Detail: deffnx. + *note Def Cmds in Detail: deffnx. `@defspec SPECIAL-FORM-NAME ARGUMENTS...' `@defspecx SPECIAL-FORM-NAME ARGUMENTS...' Format a description for a special form. The command is equivalent to `@deffn {Special Form} ...'. *Note Definition - Commands::, and *Note Def Cmds in Detail: deffnx. + Commands::, and *note Def Cmds in Detail: deffnx. `@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...' `@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...' Format a description for a data type. `@deftp' takes as arguments the category, the name of the type (which is a word like `int' or `float'), and then the names of attributes of objects of that type. - *Note Definition Commands::, and *Note Data Types::. + *Note Definition Commands::, and *note Data Types::. `@deftypecv CATEGORY CLASS DATA-TYPE NAME' `@deftypecvx CATEGORY CLASS DATA-TYPE NAME' Format a description for a typed class variable in object-oriented - programming. *Note Definition Commands::, and *Note Abstract + programming. *Note Definition Commands::, and *note Abstract Objects::. `@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...' @@ -13415,63 +14208,63 @@ given in the section below. arguments and that is typed. `@deftypefn' takes as arguments the classification of entity being described, the type, the name of the entity, and its arguments, if any. *Note Definition Commands::, - and *Note Def Cmds in Detail: deffnx. + and *note Def Cmds in Detail: deffnx. `@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...' `@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...' Format a description for a function in a typed language. The command is equivalent to `@deftypefn Function ...'. *Note - Definition Commands::, and *Note Def Cmds in Detail: deffnx. + Definition Commands::, and *note Def Cmds in Detail: deffnx. `@deftypeivar CLASS DATA-TYPE VARIABLE-NAME' `@deftypeivarx CLASS DATA-TYPE VARIABLE-NAME' Format a description for a typed instance variable in object-oriented programming. *Note Definition Commands::, and - *Note Abstract Objects::. + *note Abstract Objects::. `@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' `@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...' Format a description for a typed method in object-oriented - programming. *Note Definition Commands::, and *Note Def Cmds in + programming. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' `@deftypeopx CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...' Format a description for a typed operation in object-oriented - programming. *Note Definition Commands::, and *Note Abstract + programming. *Note Definition Commands::, and *note Abstract Objects::. `@deftypevar DATA-TYPE VARIABLE-NAME' `@deftypevarx DATA-TYPE VARIABLE-NAME' Format a description for a variable in a typed language. The command is equivalent to `@deftypevr Variable ...'. *Note - Definition Commands::, and *Note Def Cmds in Detail: deffnx. + Definition Commands::, and *note Def Cmds in Detail: deffnx. `@deftypevr CLASSIFICATION DATA-TYPE NAME' `@deftypevrx CLASSIFICATION DATA-TYPE NAME' Format a description for something like a variable in a typed language--an entity that records a value. Takes as arguments the classification of entity being described, the type, and the name - of the entity. *Note Definition Commands::, and *Note Def Cmds in + of the entity. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@defun FUNCTION-NAME ARGUMENTS...' `@defunx FUNCTION-NAME ARGUMENTS...' Format a description for functions. The command is equivalent to - `@deffn Function ...'. *Note Definition Commands::, and *Note Def + `@deffn Function ...'. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@defvar VARIABLE-NAME' `@defvarx VARIABLE-NAME' Format a description for variables. The command is equivalent to - `@defvr Variable ...'. *Note Definition Commands::, and *Note Def + `@defvr Variable ...'. *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@defvr CATEGORY NAME' `@defvrx CATEGORY NAME' Format a description for any kind of variable. `@defvr' takes as arguments the category of the entity and the name of the entity. - *Note Definition Commands::, and *Note Def Cmds in Detail: deffnx. + *Note Definition Commands::, and *note Def Cmds in Detail: deffnx. `@detailmenu' Avoid `makeinfo' confusion stemming from the detailed node listing @@ -13539,7 +14332,7 @@ given in the section below. `@env': env. `@enddots{}' - Generate an end-of-sentence of ellipsis, like this .... *Note + Generate an end-of-sentence of ellipsis, like this ... *Note `@dots{}': dots. `@enumerate [NUMBER-OR-LETTER]' @@ -13551,6 +14344,9 @@ given in the section below. Indicate to the reader the exact equivalence of two forms with a glyph: `=='. *Note Equivalence::. +`@euro{}' + Generate the Euro currency sign. *Note `@euro{}': euro. + `@error{}' Indicate to the reader with a glyph that the following text is an error message: `error-->'. *Note Error Glyph::. @@ -13630,6 +14426,9 @@ given in the section below. `@table', except for indexing. *Note `@ftable' and `@vtable': ftable vtable. +`@geq{}' + Generate a greater-than-or-equal sign, `>='. *Note geq leq::. + `@group' Hold text together that must appear on one printed page. Pair with `@end group'. Not relevant to Info. *Note `@group': group. @@ -13680,7 +14479,7 @@ given in the section below. `@ifnotxml' Begin a stretch of text that will be ignored in one output format but not the others. The text appears in the formats not specified: - `@ifnothtml' text is omitted from html output, etc. The exception + `@ifnothtml' text is omitted from HTML output, etc. The exception is `@ifnotinfo' text, which is omitted from plain text output as well as Info output. Pair with the corresponding `@end ifnotFORMAT'. *Note Conditionals::. @@ -13770,6 +14569,9 @@ given in the section below. `@LaTeX{}' Insert the logo LaTeX. *Note TeX and LaTeX: tex. +`@leq{}' + Generate a less-than-or-equal sign, `<='. *Note geq leq::. + `@lisp' Begin an example of Lisp code. Indent text, do not fill, and select fixed-width font. Pair with `@end lisp'. *Note `@lisp': @@ -13930,6 +14732,10 @@ given in the section below. characters. Used for single characters, for statements, and often for entire shell commands. *Note `@samp': samp. +`@sansserif{TEXT}' + Print TEXT in a sans serif font if possible. No effect in Info. + *Note Fonts::. + `@sc{TEXT}' Set TEXT in a printed output in THE SMALL CAPS FONT and set text in the Info file in uppercase letters. *Note Smallcaps::. @@ -13983,10 +14789,14 @@ given in the section below. `@shorttitlepage TITLE' Generate a minimal title page. *Note `@titlepage': titlepage. +`@slanted{TEXT}' + Print TEXT in a slanted font if possible. No effect in Info. + *Note Fonts::. + `@smallbook' Cause TeX to produce a printed manual in a 7 by 9.25 inch format rather than the regular 8.5 by 11 inch format. *Note Printing - Small Books: smallbook. Also, see *Note small::. + Small Books: smallbook. Also, see *note small::. `@smalldisplay' Begin a kind of example. Like `@smallexample' (narrow margins, no @@ -14077,8 +14887,8 @@ given in the section below. each first column entry on the same line as `@item'. First column entries are printed in the font resulting from FORMATTING-COMMAND. Pair with `@end table'. *Note Making a Two-column Table: - Two-column Tables. Also see *Note `@ftable' and `@vtable': ftable - vtable, and *Note `@itemx': itemx. + Two-column Tables. Also see *note `@ftable' and `@vtable': ftable + vtable, and *note `@itemx': itemx. `@TeX{}' Insert the logo TeX. *Note TeX and LaTeX: tex. @@ -14089,14 +14899,16 @@ given in the section below. `@thischapter' `@thischaptername' +`@thischapternum' `@thisfile' `@thispage' `@thistitle' - Only allowed in a heading or footing. Stands for the number and - name of the current chapter (in the format `Chapter 1: Title'), - the chapter name only, the filename, the current page number, and - the title of the document, respectively. *Note How to Make Your - Own Headings: Custom Headings. + Only allowed in a heading or footing. Stands for, respectively, + the number and name of the current chapter (in the format `Chapter + 1: Title'), the current chapter name only, the current chapter + number only, the filename, the current page number, and the title + of the document, respectively. *Note How to Make Your Own + Headings: Custom Headings. `@tie{}' Generate a normal interword space at which a line break is not @@ -14216,8 +15028,8 @@ given in the section below. In a printed manual, insert whitespace so as to push text on the remainder of the page towards the bottom of the page. Used in formatting the copyright page with the argument `0pt plus 1filll'. - (Note spelling of `filll'.) `@vskip' may be used only in - contexts ignored for Info. *Note Copyright::. + (Note spelling of `filll'.) `@vskip' may be used only in contexts + ignored for Info. *Note Copyright::. `@vtable FORMATTING-COMMAND' Begin a two-column table, using `@item' for each entry. @@ -14239,7 +15051,7 @@ given in the section below. mandatory. *Note `@xref': xref. -File: texinfo.info, Node: Command Syntax, Up: Command List +File: texinfo, Node: Command Syntax, Up: Command List A.1 @-Command Syntax ==================== @@ -14251,11 +15063,9 @@ the same meaning that `\' has in plain TeX.) Texinfo has four types of 1. Non-alphabetic commands. These commands consist of an @ followed by a punctuation mark or other character that is not part of the alphabet. Non-alphabetic - commands are almost always part of the text within a paragraph, - and never take any argument. The two characters (@ and the other - one) are complete in themselves; none is followed by braces. The - non-alphabetic commands are: `@.', `@:', `@*', `@SPACE', `@TAB', - `@NL', `@@', `@{', and `@}'. + commands are almost always part of the text within a paragraph. + The non-alphabetic commands include `@@', `@{', `@}', `@.', + `@SPACE', most of the accent commands, and many more. 2. Alphabetic commands that do not require arguments. These commands start with @ followed by a word followed by left- @@ -14298,7 +15108,7 @@ because it cannot appear at the beginning of a line. It is also no longer needed, since all formatters now refill paragraphs automatically. -File: texinfo.info, Node: Tips, Next: Sample Texinfo Files, Prev: Command List, Up: Top +File: texinfo, Node: Tips, Next: Sample Texinfo Files, Prev: Command List, Up: Top Appendix B Tips and Hints ************************* @@ -14332,8 +15142,8 @@ split across pages. different place in the document. * Write index entries only where a topic is discussed significantly. - For example, it is not useful to index "debugging information" in - a chapter on reporting bugs. Someone who wants to know about + For example, it is not useful to index "debugging information" in a + chapter on reporting bugs. Someone who wants to know about debugging information will certainly not find it in that chapter. * Consistently capitalize the first word of every concept index @@ -14422,7 +15232,7 @@ section (for people reading the printed output) and the Top node (for people reading the online output). It is easiest to do this using `@set' and `@value'. *Note `@value' -Example: value Example, and *Note GNU Sample Texts::. +Example: value Example, and *note GNU Sample Texts::. Definition Commands ................... @@ -14607,7 +15417,7 @@ And Finally ... it is as if the text were within `@ignore' ... `@end ignore'. -File: texinfo.info, Node: Sample Texinfo Files, Next: Include Files, Prev: Tips, Up: Top +File: texinfo, Node: Sample Texinfo Files, Next: Include Files, Prev: Tips, Up: Top Appendix C Sample Texinfo Files ******************************* @@ -14624,7 +15434,7 @@ the full texts to be used in GNU manuals. * All-permissive Copying License:: -File: texinfo.info, Node: Short Sample Texinfo File, Next: GNU Sample Texts, Up: Sample Texinfo Files +File: texinfo, Node: Short Sample Texinfo File, Next: GNU Sample Texts, Up: Sample Texinfo Files C.1 Short Sample ================ @@ -14647,7 +15457,7 @@ printed manual. @copying This is a short example of a complete Texinfo file. - Copyright (C) 2004 Free Software Foundation, Inc. + Copyright (C) 2005 Free Software Foundation, Inc. @end copying @titlepage @@ -14701,7 +15511,7 @@ printed manual. @bye -File: texinfo.info, Node: GNU Sample Texts, Next: Verbatim Copying License, Prev: Short Sample Texinfo File, Up: Sample Texinfo Files +File: texinfo, Node: GNU Sample Texts, Next: Verbatim Copying License, Prev: Short Sample Texinfo File, Up: Sample Texinfo Files C.2 GNU Sample Texts ==================== @@ -14722,9 +15532,9 @@ Beginning a File::, for a full explanation of that minimal example. Here are some notes on the example: * The `$Id:' comment is for the CVS (*note Overview: (cvs)Top.) or - RCS (see rcsintro(1)) version control systems, which expand it - into a string such as: - $Id: texinfo.txi,v 1.52 2004/04/09 21:30:07 karl Exp $ + RCS (`http://www.gnu.org/software/rcs') version control systems, + which expand it into a string such as: + $Id: texinfo.txi,v 1.220 2008/04/09 17:07:31 karl Exp $ (This is useful in all sources that use version control, not just manuals.) You may wish to include the `$Id:' comment in the `@copying' text, if you want a completely unambiguous reference to @@ -14762,9 +15572,15 @@ Beginning a File::, for a full explanation of that minimal example. in that case the sample texts given here have to be modified. *Note GNU Free Documentation License::. - * If your manual has invariant sections (again, see the license - itself for details), then don't forget to change the text here - accordingly. + * If the FSF is not the copyright holder, then use the appropriate + name. + + * If your manual is not published on paper by the FSF, then omit the + last sentence in the Back-Cover Text that talks about copies from + GNU Press. + + * If your manual has Invariant Sections (again, see the license + itself for details), then change the text here accordingly. * For documents that express your personal views, feelings or experiences, it is more appropriate to use a license permitting @@ -14774,9 +15590,8 @@ Beginning a File::, for a full explanation of that minimal example. Here is the sample document: - \input texinfo @c -*-texinfo-*- -@comment $Id: texinfo.txi,v 1.52 2004/04/09 21:30:07 karl Exp $ +@comment $Id: texinfo.txi,v 1.220 2008/04/09 17:07:31 karl Exp $ @comment %**start of header @setfilename sample.info @include version.texi @@ -14784,24 +15599,23 @@ Beginning a File::, for a full explanation of that minimal example. @syncodeindex pg cp @comment %**end of header @copying -This manual is for GNU Sample -(version @value{VERSION}, @value{UPDATED}), +This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}), which is an example in the Texinfo documentation. -Copyright @copyright{} 2004 Free Software Foundation, Inc. +Copyright @copyright{} 2007 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 or +under the terms of the GNU Free Documentation License, Version 1.2 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.'' +(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.'' @end quotation @end copying @@ -14825,7 +15639,7 @@ Software Foundation raise funds for GNU development.'' @node Top @top GNU Sample -@insertcopying +This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}). @end ifnottex @menu @@ -14846,12 +15660,8 @@ invoke, but if there was, you could see its basic usage and command line options here. -@node Copying This Manual -@appendix Copying This Manual - -@menu -* GNU Free Documentation License:: License for copying this manual. -@end menu +@node GNU Free Documentation License +@appendix GNU Free Documentation License @include fdl.texi @@ -14864,7 +15674,7 @@ and command line options here. @bye -File: texinfo.info, Node: Verbatim Copying License, Next: All-permissive Copying License, Prev: GNU Sample Texts, Up: Sample Texinfo Files +File: texinfo, Node: Verbatim Copying License, Next: All-permissive Copying License, Prev: GNU Sample Texts, Up: Sample Texinfo Files C.3 Verbatim Copying License ============================ @@ -14881,11 +15691,10 @@ permitting only verbatim copying. only. This is just the license text itself. For a complete sample document, see the previous sections. - @copying This document is a sample for allowing verbatim copying only. -Copyright @copyright{} 2004 Free Software Foundation, Inc. +Copyright @copyright{} 2005 Free Software Foundation, Inc. @quotation Permission is granted to make and distribute verbatim copies @@ -14895,7 +15704,7 @@ copyright notice and this permission notice are preserved. @end copying -File: texinfo.info, Node: All-permissive Copying License, Prev: Verbatim Copying License, Up: Sample Texinfo Files +File: texinfo, Node: All-permissive Copying License, Prev: Verbatim Copying License, Up: Sample Texinfo Files C.4 All-permissive Copying License ================================== @@ -14913,14 +15722,14 @@ all-permissive license. the license text itself. For a complete sample document, see the previous sections. - Copyright (C) 2004 Free Software Foundation, Inc. + Copyright (C) 2005 Free Software Foundation, Inc. Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. -File: texinfo.info, Node: Include Files, Next: Headings, Prev: Sample Texinfo Files, Up: Top +File: texinfo, Node: Include Files, Next: Headings, Prev: Sample Texinfo Files, Up: Top Appendix D Include Files ************************ @@ -14946,7 +15755,7 @@ conveniently small parts. has changed over time. -File: texinfo.info, Node: Using Include Files, Next: texinfo-multiple-files-update, Up: Include Files +File: texinfo, Node: Using Include Files, Next: texinfo-multiple-files-update, Up: Include Files D.1 How to Use Include Files ============================ @@ -14997,7 +15806,7 @@ Small includable files like this are created by Automake (*note GNU Sample Texts::). -File: texinfo.info, Node: texinfo-multiple-files-update, Next: Include Files Requirements, Prev: Using Include Files, Up: Include Files +File: texinfo, Node: texinfo-multiple-files-update, Next: Include Files Requirements, Prev: Using Include Files, Up: Include Files D.2 `texinfo-multiple-files-update' =================================== @@ -15057,7 +15866,7 @@ command inserts a master menu; with a numeric prefix argument, such as files and then inserts a master menu. -File: texinfo.info, Node: Include Files Requirements, Next: Sample Include File, Prev: texinfo-multiple-files-update, Up: Include Files +File: texinfo, Node: Include Files Requirements, Next: Sample Include File, Prev: texinfo-multiple-files-update, Up: Include Files D.3 Include Files Requirements ============================== @@ -15083,7 +15892,7 @@ should _not_ contain any nodes besides the single `Top' node. The `texinfo-multiple-files-update' command will not process them. -File: texinfo.info, Node: Sample Include File, Next: Include Files Evolution, Prev: Include Files Requirements, Up: Include Files +File: texinfo, Node: Sample Include File, Next: Include Files Evolution, Prev: Include Files Requirements, Up: Include Files D.4 Sample File with `@include' =============================== @@ -15129,7 +15938,7 @@ Manual' is named `elisp.texi'. This outer file contains a master menu with 417 entries and a list of 41 `@include' files. -File: texinfo.info, Node: Include Files Evolution, Prev: Sample Include File, Up: Include Files +File: texinfo, Node: Include Files Evolution, Prev: Sample Include File, Up: Include Files D.5 Evolution of Include Files ============================== @@ -15144,7 +15953,7 @@ way, Emacs could avoid wasting memory. References from one file to another were made by referring to the file name as well as the node name. (*Note Referring to Other Info Files: -Other Info Files. Also, see *Note `@xref' with Four and Five +Other Info Files. Also, see *note `@xref' with Four and Five Arguments: Four and Five Arguments.) Include files were designed primarily as a way to create a single, @@ -15170,7 +15979,7 @@ write menus and cross references without naming the different Texinfo files. -File: texinfo.info, Node: Headings, Next: Catching Mistakes, Prev: Include Files, Up: Top +File: texinfo, Node: Headings, Next: Catching Mistakes, Prev: Include Files, Up: Top Appendix E Page Headings ************************ @@ -15188,7 +15997,7 @@ paginated.) * Custom Headings:: How to create your own headings and footings. -File: texinfo.info, Node: Headings Introduced, Next: Heading Format, Up: Headings +File: texinfo, Node: Headings Introduced, Next: Heading Format, Up: Headings E.1 Headings Introduced ======================= @@ -15226,7 +16035,7 @@ flushleft; text for the middle part is centered; and, text for the right part is set flushright. -File: texinfo.info, Node: Heading Format, Next: Heading Choice, Prev: Headings Introduced, Up: Headings +File: texinfo, Node: Heading Format, Next: Heading Choice, Prev: Headings Introduced, Up: Headings E.2 Standard Heading Formats ============================ @@ -15283,7 +16092,7 @@ and a colon. This makes it easier to keep track of where you are in the manual. -File: texinfo.info, Node: Heading Choice, Next: Custom Headings, Prev: Heading Format, Up: Headings +File: texinfo, Node: Heading Choice, Next: Custom Headings, Prev: Heading Format, Up: Headings E.3 Specifying the Type of Heading ================================== @@ -15310,7 +16119,7 @@ No `@setchapternewpage' command of the preceding chapter, after skipping some vertical whitespace. Also cause TeX to typeset for single-sided printing. (You can override the headers format with the `@headings double' command; - see *Note The `@headings' Command: headings on off.) + see *note The `@headings' Command: headings on off.) `@setchapternewpage odd' Specify the double-sided heading format, with chapters on new @@ -15319,7 +16128,7 @@ No `@setchapternewpage' command Texinfo lacks an `@setchapternewpage even' command. -File: texinfo.info, Node: Custom Headings, Prev: Heading Choice, Up: Headings +File: texinfo, Node: Custom Headings, Prev: Heading Choice, Up: Headings E.4 How to Make Your Own Headings ================================= @@ -15388,9 +16197,23 @@ and `@end iftex' commands. `@thispage' Expands to the current page number. +`@thissectionname' + Expands to the name of the current section. + +`@thissectionnum' + Expands to the number of the current section. + +`@thissection' + Expands to the number and name of the current section, in the + format `Section 1: Title'. + `@thischaptername' Expands to the name of the current chapter. +`@thischapternum' + Expands to the number of the current chapter, or letter of the + current appendix. + `@thischapter' Expands to the number and name of the current chapter, in the format `Chapter 1: Title'. @@ -15421,8 +16244,36 @@ particularly when you are writing drafts: Beware of overlong titles: they may overlap another part of the header or footer and blot it out. + If you have very short chapters and/or sections, several of them can +appear on a single page. You can specify which chapters and sections +you want `@thischapter', `@thissection' and other such macros to refer +to on such pages as follows: + +`@everyheadingmarks REF' +`@everyfootingmarks REF' + The REF argument can be either `top' (the `@this...' commands will + refer to the chapter/section at the top of a page) or `bottom' + (the commands will reflect the situation at the bottom of a page). + These `@every...' commands specify what to do on both even- and + odd-numbered pages. + +`@evenheadingmarks REF' +`@oddheadingmarks REF' +`@evenfootingmarks REF' +`@oddfootingmarks REF' + These `@even...' and `@odd...' commands specify what to do on only + even- or odd-numbered pages, respectively. The REF argument is + the same as with the `@every...' commands. + + Write these commands immediately after the `@...contents' commands, +or after the `@end titlepage' command if you don't have a table of +contents or if it is printed at the end of your manual. + + By default the `@this...' commands reflect the situation at the +bottom of a page both in headings and in footings. + -File: texinfo.info, Node: Catching Mistakes, Next: Copying This Manual, Prev: Headings, Up: Top +File: texinfo, Node: Catching Mistakes, Next: GNU Free Documentation License, Prev: Headings, Up: Top Appendix F Formatting Mistakes ****************************** @@ -15453,7 +16304,7 @@ command and you can use the `M-x Info-validate' command. * Running Info-Validate:: How to find badly referenced nodes. -File: texinfo.info, Node: makeinfo Preferred, Next: Debugging with Info, Up: Catching Mistakes +File: texinfo, Node: makeinfo Preferred, Next: Debugging with Info, Up: Catching Mistakes F.1 `makeinfo' Find Errors ========================== @@ -15473,7 +16324,7 @@ problem is very puzzling, then you may want to use the tools described in this appendix. -File: texinfo.info, Node: Debugging with Info, Next: Debugging with TeX, Prev: makeinfo Preferred, Up: Catching Mistakes +File: texinfo, Node: Debugging with Info, Next: Debugging with TeX, Prev: makeinfo Preferred, Up: Catching Mistakes F.2 Catching Errors with Info Formatting ======================================== @@ -15555,7 +16406,7 @@ Mistakes' node. (If you try this, you can return from the `Catching Mistakes' node by typing `l' (`Info-last').) -File: texinfo.info, Node: Debugging with TeX, Next: Using texinfo-show-structure, Prev: Debugging with Info, Up: Catching Mistakes +File: texinfo, Node: Debugging with TeX, Next: Using texinfo-show-structure, Prev: Debugging with Info, Up: Catching Mistakes F.3 Catching Errors with TeX Formatting ======================================= @@ -15661,7 +16512,7 @@ in this circumstance, you are working directly with TeX, not with Texinfo.) -File: texinfo.info, Node: Using texinfo-show-structure, Next: Using occur, Prev: Debugging with TeX, Up: Catching Mistakes +File: texinfo, Node: Using texinfo-show-structure, Next: Using occur, Prev: Debugging with TeX, Up: Catching Mistakes F.4 Using `texinfo-show-structure' ================================== @@ -15725,7 +16576,7 @@ at the list in the `*Occur*' window; and if you have mis-named a node or left out a section, you can correct the mistake. -File: texinfo.info, Node: Using occur, Next: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes +File: texinfo, Node: Using occur, Next: Running Info-Validate, Prev: Using texinfo-show-structure, Up: Catching Mistakes F.5 Using `occur' ================= @@ -15761,7 +16612,7 @@ section and therefore have the same `Up' pointer. information. -File: texinfo.info, Node: Running Info-Validate, Prev: Using occur, Up: Catching Mistakes +File: texinfo, Node: Running Info-Validate, Prev: Using occur, Up: Catching Mistakes F.6 Finding Badly Referenced Nodes ================================== @@ -15787,7 +16638,7 @@ Info file from scratch. * Splitting:: How to split a file manually. -File: texinfo.info, Node: Using Info-validate, Next: Unsplit, Up: Running Info-Validate +File: texinfo, Node: Using Info-validate, Next: Unsplit, Up: Running Info-Validate F.6.1 Running `Info-validate' ----------------------------- @@ -15834,7 +16685,7 @@ that it does not split the Info file; and you must create a tag table for the unsplit file. -File: texinfo.info, Node: Unsplit, Next: Tagifying, Prev: Using Info-validate, Up: Running Info-Validate +File: texinfo, Node: Unsplit, Next: Tagifying, Prev: Using Info-validate, Up: Running Info-Validate F.6.2 Creating an Unsplit File ------------------------------ @@ -15862,7 +16713,7 @@ When you do this, Texinfo will not split the file and will not create a tag table for it. -File: texinfo.info, Node: Tagifying, Next: Splitting, Prev: Unsplit, Up: Running Info-Validate +File: texinfo, Node: Tagifying, Next: Splitting, Prev: Unsplit, Up: Running Info-Validate F.6.3 Tagifying a File ---------------------- @@ -15891,7 +16742,7 @@ table and split the file automatically, or you can make the tag table and split the file manually. -File: texinfo.info, Node: Splitting, Prev: Tagifying, Up: Running Info-Validate +File: texinfo, Node: Splitting, Prev: Tagifying, Up: Running Info-Validate F.6.4 Splitting a File Manually ------------------------------- @@ -15932,25 +16783,15 @@ generated by appending `-' and a number to the original file name. the tag table and a directory of subfiles. -File: texinfo.info, Node: Copying This Manual, Next: Command and Variable Index, Prev: Catching Mistakes, Up: Top - -Appendix G Copying This Manual -****************************** - -* Menu: - -* GNU Free Documentation License:: License for copying this manual. - - -File: texinfo.info, Node: GNU Free Documentation License, Up: Copying This Manual +File: texinfo, Node: GNU Free Documentation License, Next: Command and Variable Index, Prev: Catching Mistakes, Up: Top -G.1 GNU Free Documentation License -================================== +Appendix G GNU Free Documentation License +***************************************** Version 1.2, November 2002 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. @@ -16342,8 +17183,8 @@ G.1 GNU Free Documentation License you may choose any version ever published (not as a draft) by the Free Software Foundation. -G.1.1 ADDENDUM: How to use this License for your documents ----------------------------------------------------------- +ADDENDUM: How to use this License for your documents +==================================================== To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license @@ -16374,7 +17215,7 @@ free software license, such as the GNU General Public License, to permit their use in free software. -File: texinfo.info, Node: Command and Variable Index, Next: Concept Index, Prev: Copying This Manual, Up: Top +File: texinfo, Node: Command and Variable Index, Next: General Index, Prev: GNU Free Documentation License, Up: Top Command and Variable Index ************************** @@ -16387,11 +17228,12 @@ commands are listed without their preceding `@'. * Menu: * ! (end of sentence): Ending a Sentence. (line 6) -* " (umlaut accent): Inserting Accents. (line 17) -* ' (umlaut accent): Inserting Accents. (line 17) +* " (umlaut accent): Inserting Accents. (line 18) +* ' (umlaut accent): Inserting Accents. (line 18) * * (force line break): Line Breaks. (line 6) -* , (cedilla accent): Inserting Accents. (line 17) +* , (cedilla accent): Inserting Accents. (line 18) * - (discretionary hyphen): - and hyphenation. (line 6) +* - (in image alt string): Image Syntax. (line 39) * . (end of sentence): Ending a Sentence. (line 6) * / (allow line break): Line Breaks. (line 6) * <colon> (suppress end-of-sentence space): Not Ending a Sentence. @@ -16399,43 +17241,46 @@ commands are listed without their preceding `@'. * <newline>: Multiple Spaces. (line 6) * <space>: Multiple Spaces. (line 6) * <tab>: Multiple Spaces. (line 6) -* = (macron accent): Inserting Accents. (line 17) +* = (macron accent): Inserting Accents. (line 18) * ? (end of sentence): Ending a Sentence. (line 6) * @ (literal @): Inserting an Atsign. (line 6) -* \ (literal \ in @math): math. (line 28) +* \ (literal \ in @math): math. (line 42) * \emergencystretch: Overfull hboxes. (line 31) * \gdef within @tex: Raw Formatter Commands. (line 29) * \input (raw TeX startup): Minimum. (line 24) * \mag (raw TeX magnification): Cropmarks and Magnification. (line 24) -* ^ (circumflex accent): Inserting Accents. (line 17) -* ` (grave accent): Inserting Accents. (line 17) -* AA: Inserting Accents. (line 37) -* aa: Inserting Accents. (line 37) +* ^ (circumflex accent): Inserting Accents. (line 18) +* ` (grave accent): Inserting Accents. (line 18) +* AA: Inserting Accents. (line 39) +* aa: Inserting Accents. (line 39) +* abbr: abbr. (line 6) * acronym: acronym. (line 6) -* AE: Inserting Accents. (line 37) -* ae: Inserting Accents. (line 37) +* AE: Inserting Accents. (line 39) +* ae: Inserting Accents. (line 39) * afourlatex: A4 Paper. (line 23) * afourpaper: A4 Paper. (line 6) * afourwide: A4 Paper. (line 23) * alias: alias. (line 6) +* allowcodebreaks: allowcodebreaks. (line 6) * anchor: anchor. (line 6) * appendix: unnumbered & appendix. (line 6) * appendixsec: unnumberedsec appendixsec heading. (line 6) * appendixsection: unnumberedsec appendixsec heading. - (line 18) + (line 19) * appendixsubsec: unnumberedsubsec appendixsubsec subheading. (line 6) * appendixsubsubsec: subsubsection. (line 6) * apply: Sample Function Definition. (line 14) +* arrow: Click Sequences. (line 17) * asis: table. (line 20) * author: title subtitle author. (line 6) -* b (bold font): Fonts. (line 6) +* b (bold font): Fonts. (line 30) * bullet: bullet. (line 6) * bye <1>: File End. (line 6) * bye: Ending a File. (line 6) @@ -16449,6 +17294,10 @@ commands are listed without their preceding `@'. (line 6) * chapter: chapter. (line 6) * cite: cite. (line 6) +* clear: set value. (line 6) +* click: Click Sequences. (line 17) +* clicksequence: Click Sequences. (line 6) +* clickstyle: Click Sequences. (line 21) * code: code. (line 6) * columnfractions: Multitable Column Widths. (line 11) @@ -16457,8 +17306,8 @@ commands are listed without their preceding `@'. * comment: Comments. (line 6) * contents: Contents. (line 6) * copying: copying. (line 6) -* copyright <1>: copying. (line 37) -* copyright: copyright symbol. (line 6) +* copyright <1>: copyright symbol. (line 6) +* copyright: copying. (line 37) * cropmarks: Cropmarks and Magnification. (line 6) * defcodeindex: New Indices. (line 6) @@ -16472,7 +17321,7 @@ commands are listed without their preceding `@'. (line 47) * defmac: Functions Commands. (line 58) * defmethod: Object-Oriented Methods. - (line 80) + (line 59) * defop: Object-Oriented Methods. (line 11) * defopt: Variables Commands. (line 56) @@ -16491,6 +17340,9 @@ commands are listed without their preceding `@'. * defun: Functions Commands. (line 48) * defvar: Variables Commands. (line 38) * defvr: Variables Commands. (line 8) +* detailmenu <1>: makeinfo Pointer Creation. + (line 24) +* detailmenu: Master Menu Parts. (line 18) * dfn: dfn. (line 6) * dircategory: Installing Dir Entries. (line 11) @@ -16501,29 +17353,37 @@ commands are listed without their preceding `@'. * docbook: Raw Formatter Commands. (line 53) * documentdescription: documentdescription. (line 6) -* documentencoding: documentencoding. (line 6) +* documentencoding <1>: documentencoding. (line 6) +* documentencoding <2>: Inserting Quotation Marks. + (line 24) +* documentencoding: Inserting Accents. (line 13) * documentlanguage: documentlanguage. (line 6) -* dotaccent: Inserting Accents. (line 17) -* dotless: Inserting Accents. (line 37) +* dotaccent: Inserting Accents. (line 18) +* dotless: Inserting Accents. (line 39) * dots: dots. (line 6) * email: email. (line 6) * emph: emph & strong. (line 6) * end <1>: Introducing Lists. (line 20) * end: Quotations and Examples. - (line 15) + (line 10) * end titlepage: end titlepage. (line 6) * enddots: dots. (line 6) * enumerate: enumerate. (line 6) * env: env. (line 6) * equiv: Equivalence. (line 6) * error: Error Glyph. (line 6) -* evenfooting: Custom Headings. (line 51) -* evenheading: Custom Headings. (line 51) -* everyfooting: Custom Headings. (line 44) -* everyheading: Custom Headings. (line 44) +* euro: euro. (line 6) +* evenfooting: Custom Headings. (line 55) +* evenfootingmarks: Custom Headings. (line 134) +* evenheading: Custom Headings. (line 55) +* evenheadingmarks: Custom Headings. (line 134) +* everyfooting: Custom Headings. (line 46) +* everyfootingmarks: Custom Headings. (line 124) +* everyheading: Custom Headings. (line 46) +* everyheadingmarks: Custom Headings. (line 124) * example: example. (line 6) * exampleindent: exampleindent. (line 6) -* exclamdown: Inserting Accents. (line 37) +* exclamdown: Inserting Accents. (line 39) * exdent: exdent. (line 6) * expansion: expansion. (line 6) * file: file. (line 6) @@ -16538,14 +17398,29 @@ commands are listed without their preceding `@'. (line 6) * fn-name: Def Cmd Continuation Lines. (line 19) +* fonttextsize: Fonts. (line 6) * foobar: Optional Arguments. (line 23) * footnote: Footnotes. (line 6) * footnotestyle: Footnote Styles. (line 44) * format: format. (line 6) * forward-word: Def Cmd Template. (line 35) +* frenchspacing: frenchspacing. (line 6) * ftable: ftable vtable. (line 6) +* geq: geq leq. (line 6) * group: group. (line 6) -* H (Hungarian umlaut accent): Inserting Accents. (line 17) +* guillemetleft: Inserting Quotation Marks. + (line 43) +* guillemetright: Inserting Quotation Marks. + (line 43) +* guillemotleft: Inserting Quotation Marks. + (line 43) +* guillemotright: Inserting Quotation Marks. + (line 43) +* guilsinglleft: Inserting Quotation Marks. + (line 43) +* guilsinglright: Inserting Quotation Marks. + (line 43) +* H (Hungarian umlaut accent): Inserting Accents. (line 18) * hbox: Overfull hboxes. (line 14) * heading: unnumberedsec appendixsec heading. (line 6) @@ -16555,7 +17430,7 @@ commands are listed without their preceding `@'. * html: Raw Formatter Commands. (line 45) * hyphenation: - and hyphenation. (line 6) -* i (italic font): Fonts. (line 6) +* i (italic font): Fonts. (line 33) * ifclear: ifset ifclear. (line 47) * ifdocbook <1>: Raw Formatter Commands. (line 53) @@ -16607,9 +17482,10 @@ commands are listed without their preceding `@'. * kbd: kbd. (line 6) * kbdinputstyle: kbd. (line 26) * key: key. (line 6) -* l: Inserting Accents. (line 37) -* L: Inserting Accents. (line 37) +* L: Inserting Accents. (line 39) +* l: Inserting Accents. (line 39) * LaTeX: tex. (line 6) +* leq: geq leq. (line 6) * lisp: lisp. (line 6) * listoffloats: listoffloats. (line 6) * lowersections: Raise/lower sections. @@ -16630,19 +17506,21 @@ commands are listed without their preceding `@'. * node: node. (line 6) * noindent: noindent. (line 6) * novalidate: Format with tex/texindex. - (line 84) -* o: Inserting Accents. (line 37) -* O: Inserting Accents. (line 37) + (line 83) +* O: Inserting Accents. (line 39) +* o: Inserting Accents. (line 39) * occur: Using occur. (line 6) * occur-mode-goto-occurrence: Showing the Structure. (line 22) -* oddfooting: Custom Headings. (line 51) -* oddheading: Custom Headings. (line 51) -* oe: Inserting Accents. (line 37) -* OE: Inserting Accents. (line 37) +* oddfooting: Custom Headings. (line 55) +* oddfootingmarks: Custom Headings. (line 134) +* oddheading: Custom Headings. (line 55) +* oddheadingmarks: Custom Headings. (line 134) +* OE: Inserting Accents. (line 39) +* oe: Inserting Accents. (line 39) * option: option. (line 6) -* ordf: Inserting Accents. (line 37) -* ordm: Inserting Accents. (line 37) +* ordf: Inserting Accents. (line 39) +* ordm: Inserting Accents. (line 39) * page: page. (line 6) * page, within @titlepage: titlepage. (line 17) * pagesizes: pagesizes. (line 6) @@ -16654,19 +17532,33 @@ commands are listed without their preceding `@'. * printindex: Printing Indices & Menus. (line 23) * pxref: pxref. (line 6) -* questiondown: Inserting Accents. (line 37) +* questiondown: Inserting Accents. (line 39) * quotation: quotation. (line 6) -* r (roman font): Fonts. (line 6) +* quotedblbase: Inserting Quotation Marks. + (line 43) +* quotedblleft: Inserting Quotation Marks. + (line 43) +* quotedblright: Inserting Quotation Marks. + (line 43) +* quoteleft: Inserting Quotation Marks. + (line 43) +* quoteright: Inserting Quotation Marks. + (line 43) +* quotesinglbase: Inserting Quotation Marks. + (line 43) +* r (roman font): Fonts. (line 36) * raisesections: Raise/lower sections. (line 6) * ref: ref. (line 6) * registeredsymbol: registered symbol. (line 6) * result: result. (line 6) -* ringaccent: Inserting Accents. (line 17) +* ringaccent: Inserting Accents. (line 18) * rmacro: Defining Macros. (line 44) * samp: samp. (line 6) +* sansserif (sans serif font): Fonts. (line 40) * sc (small caps font): Smallcaps. (line 6) * section: section. (line 6) +* set: set value. (line 6) * setchapternewpage: setchapternewpage. (line 6) * setcontentsaftertitlepage: Contents. (line 51) * setfilename: setfilename. (line 6) @@ -16676,16 +17568,17 @@ commands are listed without their preceding `@'. (line 6) * shortcontents: Contents. (line 6) * shorttitlepage: titlepage. (line 46) +* slanted (slanted font): Fonts. (line 43) * smallbook: smallbook. (line 6) -* smalldisplay <1>: small. (line 6) -* smalldisplay: display. (line 16) +* smalldisplay <1>: display. (line 17) +* smalldisplay: small. (line 6) * smallexample: small. (line 6) * smallformat <1>: format. (line 15) * smallformat: small. (line 6) * smalllisp: small. (line 6) * sp (line spacing): sp. (line 6) * sp (titlepage line spacing): titlefont center sp. (line 6) -* ss: Inserting Accents. (line 37) +* ss: Inserting Accents. (line 39) * strong: emph & strong. (line 6) * subheading: unnumberedsubsec appendixsubsec subheading. (line 6) @@ -16697,7 +17590,7 @@ commands are listed without their preceding `@'. * summarycontents: Contents. (line 6) * syncodeindex: syncodeindex. (line 6) * synindex: synindex. (line 6) -* t (typewriter font): Fonts. (line 6) +* t (typewriter font): Fonts. (line 46) * tab: Multitable Rows. (line 6) * table: Two-column Tables. (line 6) * tex: Raw Formatter Commands. @@ -16735,33 +17628,38 @@ commands are listed without their preceding `@'. (line 34) * texinfo-sequential-node-update: Other Updating Commands. (line 54) -* texinfo-show-structure <1>: Showing the Structure. - (line 18) -* texinfo-show-structure: Using texinfo-show-structure. +* texinfo-show-structure <1>: Using texinfo-show-structure. (line 6) +* texinfo-show-structure: Showing the Structure. + (line 18) * texinfo-start-menu-description: Inserting. (line 94) * texinfo-tex-buffer: Printing. (line 21) * texinfo-tex-print: Printing. (line 42) * texinfo-tex-region: Printing. (line 27) * texinfo-update-node: Updating Commands. (line 83) -* thischapter: Custom Headings. (line 73) -* thischaptername: Custom Headings. (line 70) -* thisfile: Custom Headings. (line 81) -* thispage: Custom Headings. (line 67) -* thistitle: Custom Headings. (line 77) +* textdegree: textdegree. (line 6) +* thischapter: Custom Headings. (line 88) +* thischaptername: Custom Headings. (line 81) +* thischapternum: Custom Headings. (line 84) +* thisfile: Custom Headings. (line 96) +* thispage: Custom Headings. (line 68) +* thissection: Custom Headings. (line 77) +* thissectionname: Custom Headings. (line 71) +* thissectionnum: Custom Headings. (line 74) +* thistitle: Custom Headings. (line 92) * tie (unbreakable interword space): tie. (line 6) -* tieaccent: Inserting Accents. (line 17) +* tieaccent: Inserting Accents. (line 18) * title: title subtitle author. (line 6) * titlefont: titlefont center sp. (line 6) * titlepage: titlepage. (line 6) -* today: Custom Headings. (line 90) -* top: The Top Node. (line 13) +* today: Custom Headings. (line 104) +* top: The Top Node. (line 12) * top (@-command): makeinfo top command. (line 6) -* u (breve accent): Inserting Accents. (line 17) -* ubaraccent: Inserting Accents. (line 17) -* udotaccent: Inserting Accents. (line 17) +* u (breve accent): Inserting Accents. (line 18) +* ubaraccent: Inserting Accents. (line 18) +* udotaccent: Inserting Accents. (line 18) * unmacro: Defining Macros. (line 56) * unnumbered: unnumbered & appendix. (line 6) @@ -16772,7 +17670,7 @@ commands are listed without their preceding `@'. * unnumberedsubsubsec: subsubsection. (line 6) * up-list: Inserting. (line 72) * uref: uref. (line 6) -* v (check accent): Inserting Accents. (line 17) +* v (check accent): Inserting Accents. (line 18) * value: set value. (line 6) * var: var. (line 6) * verb: verb. (line 6) @@ -16786,132 +17684,184 @@ commands are listed without their preceding `@'. * xref: xref. (line 6) * { (literal {): Inserting Braces. (line 6) * } (literal }): Inserting Braces. (line 6) -* ~ (tilde accent): Inserting Accents. (line 17) +* ~ (tilde accent): Inserting Accents. (line 18) -File: texinfo.info, Node: Concept Index, Prev: Command and Variable Index, Up: Top +File: texinfo, Node: General Index, Prev: Command and Variable Index, Up: Top -Concept Index +General Index ************* * Menu: -* !: Inserting Accents. (line 37) +* !: Inserting Accents. (line 39) +* ": Inserting Quotation Marks. + (line 43) +* " (double low-9 quotation mark): Inserting Quotation Marks. + (line 43) * $Id: GNU Sample Texts. (line 21) * $Id expansion, preventing: w. (line 28) +* ': Inserting Quotation Marks. + (line 43) * (dir) as Up node of Top node: First Node. (line 13) +* , (single low-9 quotation mark): Inserting Quotation Marks. + (line 43) +* -, breakpoint within @code: allowcodebreaks. (line 6) +* --align=COLUMN: Invoking install-info. + (line 37) +* --calign=COLUMN: Invoking install-info. + (line 47) +* --command (texi2dvi): Format with texi2dvi. + (line 23) * --commands-in-node-names: makeinfo options. (line 34) * --css-include: makeinfo options. (line 41) +* --css-ref: makeinfo options. (line 46) +* --debug: Invoking install-info. + (line 55) * --delete: Invoking install-info. - (line 32) + (line 58) +* --description=TEXT: Invoking install-info. + (line 64) * --dir-file=NAME: Invoking install-info. - (line 38) -* --docbook: makeinfo options. (line 46) -* --enable-encoding <1>: makeinfo options. (line 49) -* --enable-encoding: documentencoding. (line 26) + (line 69) +* --disable-encoding: makeinfo options. (line 52) +* --docbook: makeinfo options. (line 59) +* --document-language: makeinfo options. (line 62) +* --dry-run: Invoking install-info. + (line 73) +* --enable-encoding <1>: makeinfo options. (line 52) +* --enable-encoding: documentencoding. (line 43) * --entry=TEXT: Invoking install-info. - (line 43) -* --error-limit=LIMIT: makeinfo options. (line 55) -* --fill-column=WIDTH: makeinfo options. (line 61) + (line 76) +* --error-limit=LIMIT: makeinfo options. (line 69) +* --fill-column=WIDTH: makeinfo options. (line 75) * --footnote-style, ignored in HTML output: HTML Translation. (line 13) -* --footnote-style=STYLE: makeinfo options. (line 70) -* --force: makeinfo options. (line 81) -* --help <1>: makeinfo options. (line 86) -* --help: Invoking install-info. - (line 51) -* --html: makeinfo options. (line 90) -* --ifdocbook: makeinfo options. (line 104) -* --ifhtml: makeinfo options. (line 105) -* --ifinfo: makeinfo options. (line 106) -* --ifplaintext: makeinfo options. (line 107) -* --iftex: makeinfo options. (line 108) -* --ifxml: makeinfo options. (line 109) +* --footnote-style=STYLE: makeinfo options. (line 84) +* --force: makeinfo options. (line 95) +* --help <1>: Invoking install-info. + (line 83) +* --help: makeinfo options. (line 100) +* --html: makeinfo options. (line 104) +* --ifdocbook: makeinfo options. (line 118) +* --ifhtml: makeinfo options. (line 119) +* --ifinfo: makeinfo options. (line 120) +* --ifplaintext: makeinfo options. (line 121) +* --iftex: makeinfo options. (line 122) +* --ifxml: makeinfo options. (line 123) * --info-dir=DIR: Invoking install-info. - (line 61) + (line 91) * --info-file=FILE: Invoking install-info. - (line 56) + (line 87) +* --infodir=DIR: Invoking install-info. + (line 95) * --item=TEXT: Invoking install-info. - (line 65) -* --macro-expand=FILE: makeinfo options. (line 117) -* --no-headers: makeinfo options. (line 123) -* --no-ifdocbook: makeinfo options. (line 138) -* --no-ifhtml: makeinfo options. (line 139) -* --no-ifinfo: makeinfo options. (line 140) -* --no-ifplaintext: makeinfo options. (line 141) -* --no-iftex: makeinfo options. (line 142) -* --no-ifxml: makeinfo options. (line 143) -* --no-number-footnotes: makeinfo options. (line 173) -* --no-pointer-validate: makeinfo options. (line 156) -* --no-split: makeinfo options. (line 148) -* --no-validate: makeinfo options. (line 156) -* --no-warn: makeinfo options. (line 163) -* --number-sections: makeinfo options. (line 169) -* --output=FILE: makeinfo options. (line 179) -* --paragraph-indent=INDENT: makeinfo options. (line 193) + (line 98) +* --keep-old: Invoking install-info. + (line 102) +* --language (texi2dvi): Format with texi2dvi. + (line 42) +* --macro-expand=FILE: makeinfo options. (line 130) +* --max-width=COLUMN: Invoking install-info. + (line 106) +* --maxwidth=COLUMN: Invoking install-info. + (line 110) +* --menuentry=TEXT: Invoking install-info. + (line 113) +* --name=TEXT: Invoking install-info. + (line 116) +* --no-headers: makeinfo options. (line 138) +* --no-ifdocbook: makeinfo options. (line 153) +* --no-ifhtml: makeinfo options. (line 154) +* --no-ifinfo: makeinfo options. (line 155) +* --no-ifplaintext: makeinfo options. (line 156) +* --no-iftex: makeinfo options. (line 157) +* --no-ifxml: makeinfo options. (line 158) +* --no-indent: Invoking install-info. + (line 126) +* --no-number-footnotes: makeinfo options. (line 164) +* --no-number-sections: makeinfo options. (line 169) +* --no-pointer-validate: makeinfo options. (line 181) +* --no-split: makeinfo options. (line 173) +* --no-validate: makeinfo options. (line 181) +* --no-warn: makeinfo options. (line 188) +* --number-sections: makeinfo options. (line 191) +* --output=FILE: makeinfo options. (line 197) +* --paragraph-indent=INDENT: makeinfo options. (line 211) +* --pdf (texi2dvi): Format with texi2dvi. + (line 32) +* --plaintext: makeinfo options. (line 138) * --quiet: Invoking install-info. - (line 69) -* --reference-limit=LIMIT: makeinfo options. (line 209) + (line 129) +* --recode (texi2dvi): Format with texi2dvi. + (line 58) +* --recode-from (texi2dvi): Format with texi2dvi. + (line 64) +* --regex=REGEX: Invoking install-info. + (line 167) * --remove: Invoking install-info. - (line 73) + (line 133) +* --remove-exactly: Invoking install-info. + (line 136) +* --section REGEX SEC: Invoking install-info. + (line 148) * --section=SEC: Invoking install-info. - (line 77) -* --split-size=NUM: makeinfo options. (line 215) -* --verbose: makeinfo options. (line 222) -* --version <1>: makeinfo options. (line 228) -* --version: Invoking install-info. - (line 84) -* --xml: makeinfo options. (line 231) -* -D DIR: Invoking install-info. - (line 61) -* -d NAME: Invoking install-info. - (line 38) + (line 140) +* --silent: Invoking install-info. + (line 130) +* --split-size=NUM: makeinfo options. (line 226) +* --test: Invoking install-info. + (line 173) +* --translate-file (texi2dvi): Format with texi2dvi. + (line 53) +* --transliterate-file-names: makeinfo options. (line 229) +* --verbose: makeinfo options. (line 238) +* --version <1>: Invoking install-info. + (line 176) +* --version: makeinfo options. (line 244) +* --xml: makeinfo options. (line 247) * -D VAR: makeinfo options. (line 30) -* -E FILE: makeinfo options. (line 117) -* -e LIMIT: makeinfo options. (line 55) -* -e TEXT: Invoking install-info. - (line 43) -* -F: makeinfo options. (line 81) -* -f WIDTH: makeinfo options. (line 61) -* -h <1>: makeinfo options. (line 86) -* -h: Invoking install-info. - (line 51) -* -I DIR: makeinfo options. (line 96) -* -i FILE: Invoking install-info. - (line 56) -* -o FILE: makeinfo options. (line 179) -* -P DIR: makeinfo options. (line 187) -* -p INDENT: makeinfo options. (line 193) -* -r: Invoking install-info. - (line 73) -* -r LIMIT: makeinfo options. (line 209) -* -s SEC: Invoking install-info. - (line 77) -* -s STYLE: makeinfo options. (line 70) -* -V <1>: Invoking install-info. - (line 84) -* -V: makeinfo options. (line 228) +* -E FILE: makeinfo options. (line 130) +* -e LIMIT: makeinfo options. (line 69) +* -F: makeinfo options. (line 95) +* -f WIDTH: makeinfo options. (line 75) +* -h: makeinfo options. (line 100) +* -I DIR: makeinfo options. (line 110) +* -o FILE: makeinfo options. (line 197) +* -P DIR: makeinfo options. (line 205) +* -p INDENT: makeinfo options. (line 211) +* -s STYLE: makeinfo options. (line 84) +* -V: makeinfo options. (line 244) * .cshrc initialization file: Preparing for TeX. (line 6) * .profile initialization file: Preparing for TeX. (line 6) -* /l: Inserting Accents. (line 37) -* /L: Inserting Accents. (line 37) -* /O: Inserting Accents. (line 37) -* /o: Inserting Accents. (line 37) +* /L: Inserting Accents. (line 39) +* /l: Inserting Accents. (line 39) +* /O: Inserting Accents. (line 39) +* /o: Inserting Accents. (line 39) * 8-bit characters, in HTML cross-references: HTML Xref 8-bit Character Expansion. (line 6) -* <acronym> tag: acronym. (line 15) -* <blockquote> HTML tag: quotation. (line 45) -* <lineannotation> Docbook tag: Fonts. (line 25) +* <: Inserting Quotation Marks. + (line 43) +* <<: Inserting Quotation Marks. + (line 43) +* <abbr> tag: abbr. (line 22) +* <acronym> tag: acronym. (line 19) +* <blockquote> HTML tag: quotation. (line 44) +* <lineannotation> Docbook tag: Fonts. (line 53) * <meta> HTML tag, and charset specification: documentencoding. - (line 35) + (line 56) * <meta> HTML tag, and document description: documentdescription. (line 6) -* <note> Docbook tag: quotation. (line 45) +* <note> Docbook tag: quotation. (line 44) * <small> tag: Smallcaps. (line 25) * <thead> HTML tag: Multitable Rows. (line 12) * <title> HTML tag: settitle. (line 21) * <URL: convention, not used: uref. (line 71) -* ?: Inserting Accents. (line 37) +* >: Inserting Quotation Marks. + (line 43) +* >>: Inserting Quotation Marks. + (line 43) +* ?: Inserting Accents. (line 39) * @ as continuation in definition commands: Def Cmd Continuation Lines. (line 6) * @-command list: Command List. (line 6) @@ -16920,38 +17870,46 @@ Concept Index * @-commands in @node, limited support: Pointer Validation. (line 36) * @-commands in nodename: Node Line Requirements. (line 23) -* @import specifications, in CSS files: HTML CSS. (line 30) +* @import specifications, in CSS files: HTML CSS. (line 35) * @include file sample: Sample Include File. (line 6) * @menu parts: Menu Parts. (line 6) * @node line writing: Writing a Node. (line 6) * @value in @node lines: Pointer Validation. (line 66) * @w, for blank items: itemize. (line 10) * \input source line ignored: setfilename. (line 16) -* a: Inserting Accents. (line 37) +* ^@^H for images in Info: Image Syntax. (line 63) +* _, breakpoint within @code: allowcodebreaks. (line 6) +* `: Inserting Quotation Marks. + (line 43) +* a: Inserting Accents. (line 39) * A4 paper, printing on: A4 Paper. (line 6) * A5 paper, printing on: A4 Paper. (line 6) -* AA: Inserting Accents. (line 37) -* aa: Inserting Accents. (line 37) -* Abbreviations for keys: key. (line 19) -* Abbreviations, tagging: acronym. (line 6) +* AA: Inserting Accents. (line 39) +* aa: Inserting Accents. (line 39) +* Abbreviations for keys: key. (line 20) +* Abbreviations, tagging: abbr. (line 6) * Abstract of document: documentdescription. (line 6) * Accents, inserting: Inserting Accents. (line 6) +* accesskey, in HTML output <1>: Writing a Menu. (line 28) +* accesskey, in HTML output: node. (line 27) * Acronyms, tagging: acronym. (line 6) -* Acute accent: Inserting Accents. (line 17) +* Acute accent: Inserting Accents. (line 18) * Adding a new Info file: New Info File. (line 6) -* ae: Inserting Accents. (line 37) -* AE: Inserting Accents. (line 37) +* AE: Inserting Accents. (line 39) +* ae: Inserting Accents. (line 39) * Aliases, command: alias. (line 6) * All-permissive copying license: All-permissive Copying License. (line 6) * Allow line break: Line Breaks. (line 6) * Alphabetical @-command list: Command List. (line 6) -* Alt attribute for images: Image Syntax. (line 30) +* Alt attribute for images: Image Syntax. (line 39) * Anchors: anchor. (line 6) +* Angle quotation marks: Inserting Quotation Marks. + (line 43) * Another Info directory: Other Info Directories. (line 6) * Arguments, repeated and optional: Optional Arguments. (line 6) -* ASCII text output: makeinfo options. (line 123) +* ASCII text output: makeinfo options. (line 138) * Aspect ratio of images: Image Scaling. (line 6) * autoexec.bat: Other Info Directories. (line 70) @@ -16961,7 +17919,7 @@ Concept Index * Automatically insert nodes, menus: Updating Nodes and Menus. (line 6) * Auxiliary files, avoiding: Format with tex/texindex. - (line 84) + (line 83) * B5 paper, printing on: pagesizes. (line 16) * Back-end output formats: Output Formats. (line 6) * Backslash in macros: Defining Macros. (line 37) @@ -16979,29 +17937,30 @@ Concept Index * Blank lines: sp. (line 6) * Blank lines, as paragraph separator: Conventions. (line 16) * Body of a macro: Defining Macros. (line 26) -* Bold font: Fonts. (line 15) +* Bold font: Fonts. (line 30) * Bolio: History. (line 30) * Book characteristics, printed: Printed Books. (line 6) * Book, printing small: smallbook. (line 6) * border-pattern: Object-Oriented Variables. - (line 58) + (line 23) * border-pattern of Window: Object-Oriented Variables. (line 77) * BoTeX: History. (line 30) * Box with rounded corners: cartouche. (line 6) * Box, ugly black in hardcopy: Overfull hboxes. (line 41) -* Braces and argument syntax: Command Syntax. (line 40) -* Braces, in macro arguments: Invoking Macros. (line 38) +* Braces and argument syntax: Command Syntax. (line 38) +* Braces, in macro arguments: Invoking Macros. (line 83) * Braces, inserting: Inserting Braces. (line 6) * Braces, when to use: Formatting Commands. (line 50) * Breaks in a line: Line Breaks. (line 6) -* Breve accent: Inserting Accents. (line 17) +* Breaks, within @code: allowcodebreaks. (line 6) +* Breve accent: Inserting Accents. (line 18) * Buffer formatting and printing: Printing. (line 6) * Bugs, reporting: Reporting Bugs. (line 6) * Bullets, inserting: Dots Bullets. (line 6) * Captions, for floats: caption shortcaption. (line 6) -* Caron accent: Inserting Accents. (line 17) +* Caron accent: Inserting Accents. (line 18) * Cascading Style Sheets, and HTML output: HTML CSS. (line 6) * Case in node name: Node Line Requirements. (line 42) @@ -17010,24 +17969,29 @@ Concept Index * Catching errors with TeX formatting: Debugging with TeX. (line 6) * Catching mistakes: Catching Mistakes. (line 6) * Categories, choosing: Installing Dir Entries. - (line 45) -* Cedilla accent: Inserting Accents. (line 17) + (line 54) +* Caveats for macro usage: Macro Details. (line 6) +* Cedilla accent: Inserting Accents. (line 18) * Centimeters: Image Scaling. (line 30) * Chapter structuring: Structuring. (line 6) * Chapters, formatting one at a time: Format with tex/texindex. - (line 84) + (line 83) * Character set, declaring: documentencoding. (line 6) * Characteristics, printed books or manuals: Printed Books. (line 6) * Characters, basic input: Conventions. (line 6) * Characters, invalid in node name: Node Line Requirements. (line 30) * Chassell, Robert J.: History. (line 6) -* Check accent: Inserting Accents. (line 17) +* Check accent: Inserting Accents. (line 18) * Checking for badly referenced nodes: Running Info-Validate. (line 6) * Checklist for bug reports: Reporting Bugs. (line 11) * Ciceros: Image Scaling. (line 39) -* Circumflex accent: Inserting Accents. (line 17) +* Circumflex accent: Inserting Accents. (line 18) +* Click sequences: Click Sequences. (line 6) +* CM-Super fonts: Inserting Quotation Marks. + (line 36) +* CM-Super fonts, installing: Preparing for TeX. (line 24) * code, value for @kbdinputstyle: kbd. (line 32) * Collapsing whitespace around continuations: Def Cmd Continuation Lines. (line 31) @@ -17052,10 +18016,10 @@ Concept Index * Commands, inserting them: Inserting. (line 6) * Commas, inserting: Inserting a Comma. (line 6) * Comments: Comments. (line 6) -* Comments, in CSS files: HTML CSS. (line 36) +* Comments, in CSS files: HTML CSS. (line 41) * Compile command for formatting: Compile-Command. (line 6) * Compressed files, reading: Invoking install-info. - (line 22) + (line 23) * Conditionally visible text: Conditionals. (line 6) * Conditionals, nested: Conditional Nesting. (line 6) * Conditions for copying Texinfo: Copying Conditions. (line 6) @@ -17077,8 +18041,10 @@ Concept Index * Copyright page: Copyright. (line 6) * Copyright page, for plain text: Titlepage & Copyright Page. (line 16) +* Copyright symbol: copyright symbol. (line 6) * Copyright word, always in English: copying. (line 44) * Correcting mistakes: Catching Mistakes. (line 6) +* Country codes: documentlanguage. (line 50) * cp (concept) index: Predefined Indices. (line 10) * Create nodes, menus automatically: Updating Nodes and Menus. (line 6) @@ -17104,12 +18070,14 @@ Concept Index * Customize Emacs package (Development/Docs/Texinfo): Texinfo Mode Printing. (line 92) * Customized highlighting: definfoenclose. (line 6) -* Customizing of TeX for Texinfo: Preparing for TeX. (line 27) +* Customizing of TeX for Texinfo: Preparing for TeX. (line 32) * CVS $Id: GNU Sample Texts. (line 21) -* Dashes in source: Conventions. (line 41) +* Dash, breakpoint within @code: allowcodebreaks. (line 6) +* Dashes in source: Conventions. (line 28) * Debugging the Texinfo structure: Catching Mistakes. (line 6) * Debugging with Info formatting: Debugging with Info. (line 6) * Debugging with TeX formatting: Debugging with TeX. (line 6) +* Default font: Fonts. (line 36) * Defining indexing entries: Indexing Commands. (line 6) * Defining macros: Defining Macros. (line 6) * Defining new indices: New Indices. (line 6) @@ -17122,10 +18090,14 @@ Concept Index * Definition lists, typesetting: table. (line 6) * Definition template: Def Cmd Template. (line 6) * Definitions grouped together: deffnx. (line 6) +* Degree symbol: textdegree. (line 6) * Delimiter character, for verbatim: verb. (line 6) * Depth of text area: pagesizes. (line 6) * Description for menu, start: Inserting. (line 94) * Description of document: documentdescription. (line 6) +* Detail menu: makeinfo Pointer Creation. + (line 24) +* Detailed menu: Master Menu Parts. (line 18) * Details of macro usage: Macro Details. (line 6) * Dido^t points: Image Scaling. (line 36) * Different cross reference commands: Cross Reference Commands. @@ -17133,7 +18105,7 @@ Concept Index * Dimension formatting: dmn. (line 6) * Dimensions and image sizes: Image Scaling. (line 14) * Dir categories, choosing: Installing Dir Entries. - (line 45) + (line 54) * dir directory for Info installation: Installing an Info File. (line 6) * dir file listing: New Info File. (line 6) @@ -17142,16 +18114,16 @@ Concept Index * dir files and Info directories: Other Info Directories. (line 6) * Dir files, compressed: Invoking install-info. - (line 22) + (line 23) * dir, created by install-info: Invoking install-info. - (line 19) + (line 20) * Display formatting: display. (line 6) -* Displayed equations: math. (line 33) +* Displayed equations: math. (line 47) * distinct, value for @kbdinputstyle: kbd. (line 32) * Distorting images: Image Scaling. (line 6) * Distribution: Software Copying Permissions. (line 6) -* Docbook output: Output Formats. (line 70) +* Docbook output: Output Formats. (line 73) * Docbook, including raw: Raw Formatter Commands. (line 6) * Document description: documentdescription. (line 6) @@ -17159,29 +18131,45 @@ Concept Index * Document language, declaring: documentlanguage. (line 6) * Document Permissions: Document Permissions. (line 6) +* Document strings, translation of: documentlanguage. (line 21) * Documentation identification: GNU Sample Texts. (line 21) -* Dot accent: Inserting Accents. (line 17) -* Dotless i, j: Inserting Accents. (line 37) +* Dot accent: Inserting Accents. (line 18) +* Dotless i, j: Inserting Accents. (line 39) * Dots, inserting <1>: dots. (line 6) * Dots, inserting: Dots Bullets. (line 6) +* Double angle quotation marks: Inserting Quotation Marks. + (line 43) +* Double guillemets: Inserting Quotation Marks. + (line 43) +* Double left-pointing angle quotation mark: Inserting Quotation Marks. + (line 43) +* Double low-9 quotation mark: Inserting Quotation Marks. + (line 43) +* Double quotation marks: Inserting Quotation Marks. + (line 43) +* Double right-pointing angle quotation mark: Inserting Quotation Marks. + (line 43) * Double-colon menu entries: Less Cluttered Menu Entry. (line 6) -* DTD, for Texinfo XML: Output Formats. (line 60) +* DTD, for Texinfo XML: Output Formats. (line 63) * Dumas, Patrice: HTML Xref. (line 21) -* Dumping a .fmt file: Preparing for TeX. (line 74) +* Dumping a .fmt file: Preparing for TeX. (line 79) * DVI file: Format with tex/texindex. (line 6) * DVI output: Output Formats. (line 36) * dvips: Output Formats. (line 36) +* EC fonts: Inserting Quotation Marks. + (line 29) +* EC fonts, installing: Preparing for TeX. (line 24) * Ellipsis, inserting: Dots Bullets. (line 6) * Em dash, compared to minus sign: minus. (line 6) -* Em dash, producing: Conventions. (line 41) +* Em dash, producing: Conventions. (line 28) * Emacs: Texinfo Mode. (line 6) * Emacs shell, format, print from: Within Emacs. (line 6) * Emacs-W3: Output Formats. (line 26) * Emphasizing text: Emphasis. (line 6) * Emphasizing text, font for: emph & strong. (line 6) -* En dash, producing: Conventions. (line 41) +* En dash, producing: Conventions. (line 28) * Encoding, declaring: documentencoding. (line 6) * End node footnote style: Footnote Styles. (line 9) * End of header line: End of Header. (line 6) @@ -17195,16 +18183,24 @@ Concept Index * Environment variable INFOPATH: Other Info Directories. (line 50) * Environment variable TEXINFO_OUTPUT_FORMAT: makeinfo options. - (line 234) -* Environment variable TEXINPUTS: Preparing for TeX. (line 37) + (line 250) +* Environment variable TEXINPUTS: Preparing for TeX. (line 42) +* eps image format: Image Syntax. (line 13) * epsf.tex: Image Scaling. (line 49) * epsf.tex, installing: Preparing for TeX. (line 20) -* Equations, displayed: math. (line 33) +* Equations, displayed: math. (line 47) * Equivalence, indicating: Equivalence. (line 6) * Error message, indicating: Error Glyph. (line 6) * Errors, parsing: makeinfo in Emacs. (line 26) -* Es-zet: Inserting Accents. (line 37) +* Es-zet: Inserting Accents. (line 39) +* Euro font: euro. (line 24) +* Euro font, installing: Preparing for TeX. (line 29) +* Euro symbol: euro. (line 6) * European A4 paper: A4 Paper. (line 6) +* European Computer Modern fonts: Inserting Quotation Marks. + (line 29) +* European Computer Modern fonts, installing: Preparing for TeX. + (line 24) * Evaluation glyph: result. (line 6) * Example beginning of Texinfo file: Sample Beginning. (line 6) * Example indentation: exampleindent. (line 6) @@ -17220,10 +18216,9 @@ Concept Index * expansion, of node names in HTML cross-references: HTML Xref Node Name Expansion. (line 6) * Expressions in a program, indicating: code. (line 10) -* F.B.I., as acronym: acronym. (line 6) -* FDL, GNU Free Documentation License: GNU Free Documentation License. - (line 6) -* Feminine ordinal: Inserting Accents. (line 37) +* Feminine ordinal: Inserting Accents. (line 39) +* feymr10: euro. (line 24) +* feymr10, installing: Preparing for TeX. (line 29) * File beginning: Beginning a File. (line 6) * File ending: Ending a File. (line 6) * File name collision: setfilename. (line 26) @@ -17237,7 +18232,7 @@ Concept Index * First node: First Node. (line 6) * First paragraph, suppressing indentation of: firstparagraphindent. (line 6) -* Fixed-width font: Fonts. (line 18) +* Fixed-width font: Fonts. (line 46) * Float environment: float. (line 6) * Floating accents, inserting: Inserting Accents. (line 6) * Floating, not yet implemented: Floats. (line 10) @@ -17245,8 +18240,9 @@ Concept Index * Floats, list of: listoffloats. (line 6) * Floats, making unnumbered: float. (line 39) * Floats, numbering of: float. (line 46) -* Flooding: pxref. (line 34) +* Flooding: pxref. (line 27) * fn (function) index: Predefined Indices. (line 13) +* Font size, reducing: Fonts. (line 6) * Fonts for indices: syncodeindex. (line 52) * Fonts for printing, not Info: Fonts. (line 6) * Footings: Headings. (line 6) @@ -17258,7 +18254,7 @@ Concept Index * Format and print hardcopy: Hardcopy. (line 6) * Format and print in Texinfo mode: Texinfo Mode Printing. (line 6) -* Format file, dumping: Preparing for TeX. (line 74) +* Format file, dumping: Preparing for TeX. (line 79) * Format with the compile command: Compile-Command. (line 6) * Format, print from Emacs shell: Within Emacs. (line 6) * Formats for images: Image Syntax. (line 10) @@ -17278,7 +18274,10 @@ Concept Index * Free Documentation License, including entire: GNU Sample Texts. (line 51) * Free Software Directory: Installing Dir Entries. - (line 45) + (line 54) +* French quotation marks: Inserting Quotation Marks. + (line 43) +* French spacing: frenchspacing. (line 6) * Frequently used commands, inserting: Inserting. (line 6) * Frontmatter, text in: Beginning a File. (line 15) * Full texts, GNU: GNU Sample Texts. (line 6) @@ -17287,13 +18286,14 @@ Concept Index * General syntactic conventions: Conventions. (line 6) * Generating menus with indices: Printing Indices & Menus. (line 6) -* Generating plain text files: makeinfo options. (line 123) -* German S: Inserting Accents. (line 37) -* GIF images, unsupported due to patents: Image Syntax. (line 37) +* Generating plain text files: makeinfo options. (line 138) +* German quotation marks: Inserting Quotation Marks. + (line 43) +* German S: Inserting Accents. (line 39) * Global Document Commands: Global Document Commands. (line 6) * Globbing: Format with tex/texindex. - (line 32) + (line 31) * Glyphs: Glyphs. (line 6) * GNU Emacs: Texinfo Mode. (line 6) * GNU Emacs shell, format, print from: Within Emacs. (line 6) @@ -17301,11 +18301,17 @@ Concept Index (line 51) * GNU sample texts: GNU Sample Texts. (line 6) * Going to other Info files' nodes: Other Info Files. (line 6) -* Grave accent: Inserting Accents. (line 17) -* Grave accent, vs. left quote: Conventions. (line 35) +* Grave accent: Inserting Accents. (line 18) +* Grave accent, vs. left quote: Inserting Quotation Marks. + (line 16) * Group (hold text together vertically): group. (line 6) * Grouping two definitions together: deffnx. (line 6) -* Hacek accent: Inserting Accents. (line 17) +* GUI click sequence: Click Sequences. (line 6) +* Guillemets: Inserting Quotation Marks. + (line 43) +* Guillemots: Inserting Quotation Marks. + (line 43) +* Hacek accent: Inserting Accents. (line 18) * Hardcopy, printing it: Hardcopy. (line 6) * hboxes, overfull: Overfull hboxes. (line 6) * Header for Texinfo files: Texinfo File Header. (line 6) @@ -17317,7 +18323,7 @@ Concept Index * Headings, page, begin to appear: end titlepage. (line 6) * Height of images: Image Scaling. (line 6) * Height of text area: pagesizes. (line 6) -* help2man: Output Formats. (line 88) +* help2man: Output Formats. (line 91) * Hierarchical documents, and menus: Menu Location. (line 16) * Highlighting text: Indicating. (line 6) * Highlighting, customized: definfoenclose. (line 6) @@ -17338,27 +18344,28 @@ Concept Index * HTML cross-references: HTML Xref. (line 6) * HTML output <1>: Generating HTML. (line 6) * HTML output: Output Formats. (line 26) -* HTML output, and encodings: documentencoding. (line 35) +* HTML output, and encodings: documentencoding. (line 56) * HTML output, browser compatibility of: HTML Translation. (line 22) * HTML output, split: HTML Splitting. (line 6) * HTML, and CSS: HTML CSS. (line 6) * HTML, including raw: Raw Formatter Commands. (line 6) -* http-equiv, and charset specification: documentencoding. (line 35) -* Hungarian umlaut accent: Inserting Accents. (line 17) +* http-equiv, and charset specification: documentencoding. (line 56) +* Hungarian umlaut accent: Inserting Accents. (line 18) * Hurricanes: ref. (line 12) +* Hyphen, breakpoint within @code: allowcodebreaks. (line 6) * Hyphen, compared to minus: minus. (line 6) -* Hyphenation patterns, language-dependent: documentlanguage. (line 18) +* Hyphenation patterns, language-dependent: documentlanguage. (line 41) * Hyphenation, helping TeX do: - and hyphenation. (line 6) * Hyphenation, preventing: w. (line 24) -* Hyphens in source, two or three in a row: Conventions. (line 41) -* i (dotless i): Inserting Accents. (line 37) +* Hyphens in source, two or three in a row: Conventions. (line 28) +* i (dotless i): Inserting Accents. (line 39) * Identification of documentation: GNU Sample Texts. (line 21) * If text conditionally visible: Conditionals. (line 6) * Ignored before @setfilename: setfilename. (line 16) * Ignored text: Comments. (line 19) * Image formats: Image Syntax. (line 10) -* Images, alternate text for: Image Syntax. (line 30) +* Images, alternate text for: Image Syntax. (line 39) * Images, inserting: Images. (line 6) * Images, scaling: Image Scaling. (line 6) * Inches: Image Scaling. (line 27) @@ -17381,7 +18388,7 @@ Concept Index * Index entries, making: Index Entries. (line 6) * Index entry writing: Indexing Commands. (line 27) * Index file names: Format with tex/texindex. - (line 24) + (line 23) * Index font types: Indexing Commands. (line 48) * Indexing table entries automatically: ftable vtable. (line 6) * Indicating commands, definitions, etc.: Indicating. (line 6) @@ -17406,7 +18413,7 @@ Concept Index * Info installed in another directory: Other Info Directories. (line 6) * Info output: Output Formats. (line 10) -* Info output, and encoding: documentencoding. (line 26) +* Info output, and encoding: documentencoding. (line 43) * Info validating a large file: Using Info-validate. (line 6) * Info, creating an online file: Creating an Info File. (line 6) @@ -17421,14 +18428,18 @@ Concept Index (line 6) * Inserting @ (literal @): Inserting an Atsign. (line 6) * Inserting accents: Inserting Accents. (line 6) -* Inserting dots <1>: Dots Bullets. (line 6) -* Inserting dots: dots. (line 6) +* Inserting dots <1>: dots. (line 6) +* Inserting dots: Dots Bullets. (line 6) * Inserting ellipsis: Dots Bullets. (line 6) * Inserting frequently used commands: Inserting. (line 6) * Inserting indentation: indent. (line 6) +* Inserting quotation marks: Inserting Quotation Marks. + (line 6) +* Inserting quote characters: Inserting Quote Characters. + (line 6) * Inserting space: Inserting Space. (line 6) * Inserting special characters and symbols: Insertions. (line 6) -* INSTALL file, generating: makeinfo options. (line 123) +* INSTALL file, generating: makeinfo options. (line 138) * install-info: Invoking install-info. (line 6) * Installing an Info file: Installing an Info File. @@ -17444,24 +18455,42 @@ Concept Index (line 30) * Invoking macros: Invoking Macros. (line 6) * Invoking nodes, including in dir file: Installing Dir Entries. - (line 62) -* ISO 639 codes: documentlanguage. (line 22) -* Italic font: Fonts. (line 12) + (line 71) +* ISO 3166 country codes: documentlanguage. (line 50) +* ISO 639-2 language codes: documentlanguage. (line 50) +* ISO 8859-1: Inserting Quotation Marks. + (line 24) +* ISO 8859-15 <1>: euro. (line 18) +* ISO 8859-15: Inserting Quotation Marks. + (line 24) +* Italic font: Fonts. (line 33) * Itemization: itemize. (line 6) -* j (dotless j): Inserting Accents. (line 37) -* JPG image format: Image Syntax. (line 37) +* j (dotless j): Inserting Accents. (line 39) +* JPEG image format: Image Syntax. (line 51) +* jpeg image format: Image Syntax. (line 15) * Keyboard input: kbd. (line 6) -* Keys, recommended names: key. (line 19) +* Keys, recommended names: key. (line 20) * Keyword expansion, preventing: w. (line 28) * Keywords, indicating: code. (line 10) * Knuth, Donald: Printed Books. (line 6) * ky (keystroke) index: Predefined Indices. (line 17) -* Language codes: documentlanguage. (line 22) +* LANG: makeinfo options. (line 62) +* Language codes: documentlanguage. (line 50) * Language, declaring: documentlanguage. (line 6) * Larger or smaller pages: Cropmarks and Magnification. (line 24) +* LaTeX logo: tex. (line 6) * LaTeX, processing with texi2dvi: Format with texi2dvi. - (line 32) + (line 39) +* Latin 1: Inserting Quotation Marks. + (line 24) +* Latin 9 <1>: euro. (line 18) +* Latin 9: Inserting Quotation Marks. + (line 24) +* Left quotation marks: Inserting Quotation Marks. + (line 43) +* Left-pointing angle quotation marks: Inserting Quotation Marks. + (line 43) * Legal paper, printing on: pagesizes. (line 16) * Length of file names: setfilename. (line 26) * Less cluttered menu entry: Less Cluttered Menu Entry. @@ -17472,8 +18501,8 @@ Concept Index (line 6) * License for verbatim copying: Verbatim Copying License. (line 6) -* Line breaks <1>: Breaks. (line 6) -* Line breaks: Line Breaks. (line 6) +* Line breaks <1>: Line Breaks. (line 6) +* Line breaks: Breaks. (line 6) * Line breaks, preventing: w. (line 6) * Line length, column widths as fraction of: Multitable Column Widths. (line 11) @@ -17485,8 +18514,10 @@ Concept Index * Listing a new Info file: New Info File. (line 6) * Lists and tables, making: Lists and Tables. (line 6) * Local variables: Compile-Command. (line 6) -* Local Variables: section, for encoding: documentencoding. (line 26) +* Local Variables: section, for encoding: documentencoding. (line 43) +* Locale, declaring: documentlanguage. (line 6) * Location of menus: Menu Location. (line 6) +* Logos, TeX: tex. (line 6) * Looking for badly referenced nodes: Running Info-Validate. (line 6) * Lowering and raising sections: Raise/lower sections. @@ -17501,10 +18532,10 @@ Concept Index * Macro expansion, indicating: expansion. (line 6) * Macro invocation: Invoking Macros. (line 6) * Macro names, valid characters in: Defining Macros. (line 16) -* Macron accent: Inserting Accents. (line 17) +* Macron accent: Inserting Accents. (line 18) * Macros: Defining New Texinfo Commands. (line 6) -* Macros in definition commands: Def Cmd Template. (line 66) +* Macros in definition commands: Def Cmd Template. (line 67) * Macros, undefining: Defining Macros. (line 56) * Magnified printing: Cropmarks and Magnification. (line 24) @@ -17518,13 +18549,13 @@ Concept Index * Making cross references: Cross References. (line 6) * Making line and page breaks: Breaks. (line 6) * Making lists and tables: Lists and Tables. (line 6) -* Man page output, not supported: Output Formats. (line 78) +* Man page output, not supported: Output Formats. (line 81) * Man page, reference to: uref. (line 20) * Manual characteristics, printed: Printed Books. (line 6) * Margins on page, not controllable: pagesizes. (line 20) * Marking text within a paragraph: Marking Text. (line 6) * Marking words and phrases: Marking Text. (line 6) -* Masculine ordinal: Inserting Accents. (line 37) +* Masculine ordinal: Inserting Accents. (line 39) * Master menu: Master Menu Parts. (line 6) * Mathematical expressions <1>: Raw Formatter Commands. (line 33) @@ -17540,8 +18571,8 @@ Concept Index * Menus: Menus. (line 6) * Menus generated with indices: Printing Indices & Menus. (line 6) -* Menus, omitting: makeinfo options. (line 123) -* META key: key. (line 53) +* Menus, omitting: makeinfo options. (line 138) +* META key: key. (line 54) * Meta-syntactic chars for arguments: Optional Arguments. (line 6) * Methods, object-oriented: Object-Oriented Methods. (line 6) @@ -17549,13 +18580,14 @@ Concept Index * Minimal requirements for formatting: Requirements Summary. (line 6) * Minimal Texinfo file (requirements): Minimum. (line 6) +* Minus sign: minus. (line 6) * Mismatched HTML cross-reference source and target: HTML Xref Mismatch. (line 6) * Mistakes, catching: Catching Mistakes. (line 6) * Mode, using Texinfo: Texinfo Mode. (line 6) -* Monospace font: Fonts. (line 18) +* Monospace font: Fonts. (line 46) * Mozilla: Output Formats. (line 26) -* Multiple dashes in source: Conventions. (line 41) +* Multiple dashes in source: Conventions. (line 28) * Multiple spaces: Multiple Spaces. (line 6) * Multitable column widths: Multitable Column Widths. (line 6) @@ -17564,13 +18596,13 @@ Concept Index * Mutually recursive macros: Defining Macros. (line 26) * Names for indices: syncodeindex. (line 17) * Names of index files: Format with tex/texindex. - (line 24) + (line 23) * Names of macros, valid characters of: Defining Macros. (line 16) -* Names recommended for keys: key. (line 19) +* Names recommended for keys: key. (line 20) * Naming a `Top' Node in references: Top Node Naming. (line 6) * NASA, as acronym: acronym. (line 6) * Navigation bar, in HTML output: HTML Translation. (line 16) -* Navigation links, omitting: makeinfo options. (line 129) +* Navigation links, omitting: makeinfo options. (line 144) * Need space at page bottom: need. (line 6) * Nesting conditionals: Conditional Nesting. (line 6) * New index defining: New Indices. (line 6) @@ -17578,7 +18610,7 @@ Concept Index * New Texinfo commands, defining: Defining New Texinfo Commands. (line 6) * Newlines, as blank lines: Conventions. (line 16) -* Next node of Top node: First Node. (line 30) +* Next node of Top node: First Node. (line 26) * Node line requirements: Node Line Requirements. (line 6) * Node line writing: Writing a Node. (line 6) @@ -17591,7 +18623,7 @@ Concept Index * Node names, choosing: Node Names. (line 6) * Node names, invalid characters in: Node Line Requirements. (line 30) -* Node separators, omitting: makeinfo options. (line 123) +* Node separators, omitting: makeinfo options. (line 138) * Node, `Top': The Top Node. (line 6) * Node, defined: node. (line 6) * Nodes in other Info files: Other Info Files. (line 6) @@ -17603,25 +18635,26 @@ Concept Index * Not ending a sentence: Not Ending a Sentence. (line 6) * Numbering of floats: float. (line 46) -* o: Inserting Accents. (line 37) -* O'Dea, Brendan: Output Formats. (line 88) +* o: Inserting Accents. (line 39) +* O'Dea, Brendan: Output Formats. (line 91) * Object-oriented programming: Abstract Objects. (line 6) +* Oblique font: Fonts. (line 43) * Obtaining TeX: Obtaining TeX. (line 6) * Occurrences, listing with @occur: Using occur. (line 6) -* OE: Inserting Accents. (line 37) -* oe: Inserting Accents. (line 37) +* OE: Inserting Accents. (line 39) +* oe: Inserting Accents. (line 39) * Omitting indentation: noindent. (line 6) * Optional and repeated arguments: Optional Arguments. (line 6) * Options for makeinfo: makeinfo options. (line 6) -* Ordinals, Romance: Inserting Accents. (line 37) +* Ordinals, Romance: Inserting Accents. (line 39) * Ordinary TeX commands, using: Raw Formatter Commands. (line 6) * Other Info files' nodes: Other Info Files. (line 6) * Outline of file structure, showing it: Showing the Structure. (line 6) -* Output file splitting: makeinfo options. (line 148) +* Output file splitting: makeinfo options. (line 173) * Output formats: Output Formats. (line 6) -* Output formats, supporting more: Output Formats. (line 95) +* Output formats, supporting more: Output Formats. (line 98) * Overfull hboxes: Overfull hboxes. (line 6) * Overview of Texinfo: Overview. (line 6) * Owner of copyright for FSF works: copying. (line 53) @@ -17650,11 +18683,11 @@ Concept Index * Parts of a master menu: Master Menu Parts. (line 6) * Parts of a menu: Menu Parts. (line 6) * Patches, contributing: Reporting Bugs. (line 30) +* pdf image inclusions: Image Syntax. (line 15) * PDF output <1>: PDF Output. (line 6) * PDF output: Output Formats. (line 51) -* pdfcolor.tex, installing: Preparing for TeX. (line 24) -* pdftex <1>: Output Formats. (line 51) -* pdftex: PDF Output. (line 6) +* pdftex <1>: PDF Output. (line 6) +* pdftex: Output Formats. (line 51) * pdftex, and images: Image Syntax. (line 15) * Period in nodename: Node Line Requirements. (line 30) @@ -17668,23 +18701,25 @@ Concept Index * Pinard, Franc,ois: History. (line 14) * Plain TeX: Raw Formatter Commands. (line 6) -* Plain text output <1>: Output Formats. (line 21) -* Plain text output: makeinfo options. (line 123) -* PNG image format: Image Syntax. (line 37) +* Plain text output <1>: makeinfo options. (line 138) +* Plain text output: Output Formats. (line 21) +* PNG image format: Image Syntax. (line 51) +* png image format: Image Syntax. (line 15) * Point, indicating in a buffer: Point Glyph. (line 6) * Pointer creation with makeinfo: makeinfo Pointer Creation. (line 6) * Pointer validation with makeinfo: Pointer Validation. (line 6) -* Pointer validation, suppressing <1>: makeinfo options. (line 156) +* Pointer validation, suppressing <1>: makeinfo options. (line 181) * Pointer validation, suppressing: Format with tex/texindex. - (line 84) + (line 83) * Points (dimension): Image Scaling. (line 18) +* Pounds symbol: pounds. (line 6) * Predefined names for indices: syncodeindex. (line 17) * Preparing for TeX: Preparing for TeX. (line 6) +* Prev node of Top node: First Node. (line 24) * Preventing first paragraph indentation: firstparagraphindent. (line 6) * Preventing line and page breaks: Breaks. (line 6) -* Previous node of Top node: First Node. (line 24) * Print and format in Texinfo mode: Texinfo Mode Printing. (line 6) * Print, format from Emacs shell: Within Emacs. (line 6) @@ -17694,6 +18729,7 @@ Concept Index * Printing a region or buffer: Printing. (line 6) * Printing an index: Printing Indices & Menus. (line 6) +* Printing cost, reducing: Fonts. (line 13) * Printing cropmarks: Cropmarks and Magnification. (line 6) * Printing DVI files, on MS-DOS/MS-Windows: Print with lpr. (line 27) @@ -17702,8 +18738,17 @@ Concept Index * Program names, indicating: command. (line 6) * Prototype row, column widths defined by: Multitable Column Widths. (line 22) -* Quotation characters (`'), in source: Conventions. (line 24) +* Quotation characters (`'), in source: Inserting Quotation Marks. + (line 6) +* Quotation marks, French: Inserting Quotation Marks. + (line 43) +* Quotation marks, German: Inserting Quotation Marks. + (line 43) +* Quotation marks, inserting: Inserting Quotation Marks. + (line 6) * Quotations: quotation. (line 6) +* Quote characters, inserting: Inserting Quote Characters. + (line 6) * Ragged left: flushleft & flushright. (line 6) * Ragged right: flushleft & flushright. @@ -17713,10 +18758,11 @@ Concept Index * Raw formatter commands: Raw Formatter Commands. (line 6) * RCS $Id: GNU Sample Texts. (line 21) -* Recommended names for keys: key. (line 19) +* Recommended names for keys: key. (line 20) * Rectangle, black in hardcopy: Overfull hboxes. (line 41) * Recursion, mutual: Defining Macros. (line 26) * Recursive macro invocations: Defining Macros. (line 44) +* Reducing font size: Fonts. (line 6) * Reference to @-commands: Command List. (line 6) * References: Cross References. (line 6) * References using @inforef: inforef. (line 6) @@ -17727,6 +18773,7 @@ Concept Index * Region formatting and printing: Printing. (line 6) * Region printing in Texinfo mode: Texinfo Mode Printing. (line 6) +* Registered symbol: registered symbol. (line 6) * Reid, Brian: History. (line 24) * Repeated and optional arguments: Optional Arguments. (line 6) * Reporting bugs: Reporting Bugs. (line 6) @@ -17742,9 +18789,13 @@ Concept Index (line 6) * Result of an expression: result. (line 6) * ridt.eps: Image Scaling. (line 44) -* Ring accent: Inserting Accents. (line 17) -* Roman font: Fonts. (line 21) -* Romance ordinals: Inserting Accents. (line 37) +* Right quotation marks: Inserting Quotation Marks. + (line 43) +* Right-pointing angle quotation marks: Inserting Quotation Marks. + (line 43) +* Ring accent: Inserting Accents. (line 18) +* Roman font: Fonts. (line 36) +* Romance ordinals: Inserting Accents. (line 39) * Rounded rectangles, around examples: cartouche. (line 6) * Rows, of a multitable: Multitable Rows. (line 6) * Running an Info formatter: Info Formatting. (line 6) @@ -17760,11 +18811,12 @@ Concept Index * Sample Texinfo files: Sample Texinfo Files. (line 6) * Sample texts, GNU: GNU Sample Texts. (line 6) +* Sans serif font: Fonts. (line 40) * Scaled points: Image Scaling. (line 42) * Scaling images: Image Scaling. (line 6) * Schwab, Andreas: History. (line 14) * Scribe: History. (line 24) -* Sea surges: ref. (line 27) +* Sea surges: ref. (line 28) * Section structure of a file, showing it: Showing the Structure. (line 6) * Sections, raising and lowering: Raise/lower sections. @@ -17772,9 +18824,11 @@ Concept Index * Sentence ending punctuation: Ending a Sentence. (line 6) * Sentence non-ending punctuation: Not Ending a Sentence. (line 6) +* Sentences, spacing after: frenchspacing. (line 6) * Separate footnote style: Footnote Styles. (line 20) -* SGML-tools output format: Output Formats. (line 95) -* Sharp S: Inserting Accents. (line 37) +* Sequence of clicks: Click Sequences. (line 6) +* SGML-tools output format: Output Formats. (line 98) +* Sharp S: Inserting Accents. (line 39) * Shell formatting with tex and texindex: Format with tex/texindex. (line 6) * Shell printing, on MS-DOS/MS-Windows: Print with lpr. (line 27) @@ -17788,17 +18842,33 @@ Concept Index * Showing the structure of a file: Using texinfo-show-structure. (line 6) * Shrubbery: ifset ifclear. (line 21) -* Site-wide Texinfo configuration file: Preparing for TeX. (line 27) +* Single angle quotation marks: Inserting Quotation Marks. + (line 43) +* Single guillemets: Inserting Quotation Marks. + (line 43) +* Single left-pointing angle quotation mark: Inserting Quotation Marks. + (line 43) +* Single low-9 quotation mark: Inserting Quotation Marks. + (line 43) +* Single quotation marks: Inserting Quotation Marks. + (line 43) +* Single right-pointing angle quotation mark: Inserting Quotation Marks. + (line 43) +* Site-wide Texinfo configuration file: Preparing for TeX. (line 32) * Size of printed book: smallbook. (line 6) +* Slanted font: Fonts. (line 43) * Slanted typewriter font, for @kbd: kbd. (line 15) * Small book size: smallbook. (line 6) * Small caps font: Smallcaps. (line 6) * Small examples: small. (line 6) +* Small verbatim: verbatim. (line 46) +* Smaller fonts: Fonts. (line 6) * Software copying permissions: Software Copying Permissions. (line 6) * Sorting indices: Hardcopy. (line 6) * Source file format: Using Texinfo. (line 19) * Source files, characters used: Conventions. (line 9) +* Space, after sentences: frenchspacing. (line 6) * Space, inserting horizontal: Multiple Spaces. (line 6) * Space, inserting vertical: sp. (line 6) * Spaces in macros: Defining Macros. (line 40) @@ -17813,8 +18883,8 @@ Concept Index * Specifying index entries: Indexing Commands. (line 6) * Split HTML output: HTML Splitting. (line 6) * Splitting an Info file manually: Splitting. (line 6) -* Splitting of output files: makeinfo options. (line 148) -* ss: Inserting Accents. (line 37) +* Splitting of output files: makeinfo options. (line 173) +* ss: Inserting Accents. (line 39) * Stallman, Richard M.: History. (line 6) * Start of header line: Start of Header. (line 6) * Starting chapters: setchapternewpage. (line 6) @@ -17822,6 +18892,7 @@ Concept Index (line 6) * Structure, catching mistakes in: Catching Mistakes. (line 6) * Structuring of chapters: Structuring. (line 6) +* Styles, font: Fonts. (line 24) * Subsection-like commands: unnumberedsubsec appendixsubsec subheading. (line 6) * Subsub commands: subsubsection. (line 6) @@ -17841,7 +18912,7 @@ Concept Index * Tables with indexes: ftable vtable. (line 6) * Tables, making multi-column: Multi-column Tables. (line 6) * Tables, making two-column: Two-column Tables. (line 6) -* Tabs; don't use!: Conventions. (line 51) +* Tabs; don't use!: Conventions. (line 38) * Tag table, making automatically: Tag and Split Files. (line 6) * Tag table, making manually: Unsplit. (line 26) * Targets for cross-references, arbitrary: anchor. (line 6) @@ -17850,15 +18921,16 @@ Concept Index (line 6) * TeX index sorting: Hardcopy. (line 6) * TeX input initialization: Preparing for TeX. (line 6) +* TeX logo: tex. (line 6) * TeX, how to obtain: Obtaining TeX. (line 6) * texi2dvi: Format with tex/texindex. - (line 76) + (line 75) * texi2dvi (shell script): Format with texi2dvi. (line 6) * texi2roff, unsupported software: Printed Books. (line 59) -* texindex <1>: Hardcopy. (line 6) -* texindex: Format with tex/texindex. +* texindex <1>: Format with tex/texindex. (line 16) +* texindex: Hardcopy. (line 6) * Texinfo commands, defining new: Defining New Texinfo Commands. (line 6) * Texinfo file beginning: Beginning a File. (line 6) @@ -17874,18 +18946,18 @@ Concept Index * Texinfo requires @setfilename: setfilename. (line 6) * Texinfo, introduction to: Using Texinfo. (line 6) * texinfo.cnf: setfilename. (line 43) -* texinfo.cnf installation: Preparing for TeX. (line 27) -* texinfo.dtd: Output Formats. (line 60) +* texinfo.cnf installation: Preparing for TeX. (line 32) +* texinfo.dtd: Output Formats. (line 63) * texinfo.tex, installing: Preparing for TeX. (line 13) -* TEXINFO_OUTPUT_FORMAT: makeinfo options. (line 234) -* TEXINPUTS: Preparing for TeX. (line 37) +* TEXINFO_OUTPUT_FORMAT: makeinfo options. (line 250) +* TEXINPUTS: Preparing for TeX. (line 42) * Text width and height: pagesizes. (line 6) * Text, conditionally visible: Conditionals. (line 6) * Text, marking up: Marking Text. (line 6) * Thin space between number, dimension: dmn. (line 6) -* Tie-after accent: Inserting Accents. (line 17) +* Tie-after accent: Inserting Accents. (line 18) * Tied space: tie. (line 6) -* Tilde accent: Inserting Accents. (line 17) +* Tilde accent: Inserting Accents. (line 18) * time-stamp.el: GNU Sample Texts. (line 32) * Tips: Tips. (line 8) * Title page: titlepage. (line 6) @@ -17898,25 +18970,29 @@ Concept Index * Top node is first: First Node. (line 6) * Top node naming for references: Top Node Naming. (line 6) * tp (data type) index: Predefined Indices. (line 23) +* Transliteration of 8-bit characters in HTML cross-references: HTML Xref 8-bit Character Expansion. + (line 6) * Tree structuring: Tree Structuring. (line 6) * Two `First' Lines for @deffn: deffnx. (line 6) * Two letter names for indices: syncodeindex. (line 17) * Two named items for @table: itemx. (line 6) * Two part menu entry: Less Cluttered Menu Entry. (line 6) -* txi-CC.tex: documentlanguage. (line 13) +* txi-CC.tex: documentlanguage. (line 28) * Typesetting commands for dots, etc.: Dots Bullets. (line 6) -* Typewriter font: Fonts. (line 18) +* Typewriter font: Fonts. (line 46) * Ugly black rectangles in hardcopy: Overfull hboxes. (line 41) -* Umlaut accent: Inserting Accents. (line 17) +* Umlaut accent: Inserting Accents. (line 18) * Unbreakable space, fixed: w. (line 9) * Unbreakable space, variable: tie. (line 6) * Uncluttered menu entry: Less Cluttered Menu Entry. (line 6) * Undefining macros: Defining Macros. (line 56) -* Underbar accent: Inserting Accents. (line 17) -* Underdot accent: Inserting Accents. (line 17) -* Unicode quotation characters: Conventions. (line 35) +* Underbar accent: Inserting Accents. (line 18) +* Underdot accent: Inserting Accents. (line 18) +* Underscore, breakpoint within @code: allowcodebreaks. (line 6) +* Unicode quotation characters: Inserting Quotation Marks. + (line 16) * Uniform resource locator, indicating: indicateurl. (line 6) * Uniform resource locator, referring to: uref. (line 6) * Unique nodename requirement: Node Line Requirements. @@ -17939,6 +19015,8 @@ Concept Index * User-defined Texinfo commands: Defining New Texinfo Commands. (line 6) * Using Texinfo in general: Using Texinfo. (line 6) +* UTF-8: Inserting Quotation Marks. + (line 24) * Validating a large file: Using Info-validate. (line 6) * Validation of pointers: Pointer Validation. (line 6) * Value of an expression, indicating: result. (line 6) @@ -17949,10 +19027,11 @@ Concept Index * Verbatim environment: verbatim. (line 6) * Verbatim in-line text: verb. (line 6) * Verbatim, include file: verbatiminclude. (line 6) +* Verbatim, small: verbatim. (line 46) * VERSION Automake variable: GNU Sample Texts. (line 32) * Version control keywords, preventing expansion of: w. (line 28) * Version number, for install-info: Invoking install-info. - (line 84) + (line 176) * Vertically holding text together: group. (line 6) * Visibility of conditional text: Conditionals. (line 6) * vr (variable) index: Predefined Indices. (line 27) @@ -17971,16 +19050,16 @@ Concept Index * Widths, defining multitable column: Multitable Column Widths. (line 6) * Wildcards: Format with tex/texindex. - (line 32) + (line 31) * Words and phrases, marking them: Marking Text. (line 6) * Writing a menu: Writing a Menu. (line 6) * Writing an @node line: Writing a Node. (line 6) * Writing index entries: Indexing Commands. (line 27) * xdvi: Output Formats. (line 36) -* XML output: Output Formats. (line 60) +* XML output: Output Formats. (line 63) * XML, including raw: Raw Formatter Commands. (line 6) -* XPM image format: Image Syntax. (line 23) +* XPM image format: Image Syntax. (line 26) * Years, in copyright line: copying. (line 48) * Zaretskii, Eli: History. (line 14) * Zuhn, David D.: History. (line 14) @@ -17988,341 +19067,349 @@ Concept Index Tag Table: -Node: Top1485 -Node: Copying Conditions26788 -Node: Overview28855 -Ref: Overview-Footnote-130234 -Node: Reporting Bugs30691 -Node: Using Texinfo32215 -Node: Output Formats33804 -Node: Info Files38893 -Ref: Info Files-Footnote-143301 -Node: Printed Books43480 -Ref: Printed Books-Footnote-146309 -Node: Formatting Commands46643 -Ref: Formatting Commands-Footnote-149496 -Node: Conventions50104 -Node: Comments53438 -Node: Minimum55068 -Node: Six Parts57631 -Node: Short Sample59285 -Node: History63419 -Node: Texinfo Mode65471 -Node: Texinfo Mode Overview66848 -Node: Emacs Editing67618 -Node: Inserting69762 -Node: Showing the Structure74049 -Node: Updating Nodes and Menus76370 -Node: Updating Commands77449 -Node: Updating Requirements83453 -Node: Other Updating Commands85842 -Node: Info Formatting89108 -Node: Printing90374 -Node: Texinfo Mode Summary92682 -Node: Beginning a File97376 -Node: Sample Beginning98795 -Node: Texinfo File Header100392 -Node: First Line101856 -Node: Start of Header102887 -Node: setfilename103878 -Node: settitle106383 -Node: End of Header108644 -Node: Document Permissions108928 -Node: copying109559 -Node: insertcopying112113 -Node: Titlepage & Copyright Page113648 -Node: titlepage115327 -Ref: titlepage-Footnote-1117834 -Node: titlefont center sp118120 -Node: title subtitle author119802 -Node: Copyright122576 -Node: end titlepage124105 -Node: headings on off125759 -Node: Contents127829 -Node: The Top Node131059 -Node: Top Node Example132363 -Node: Master Menu Parts132748 -Node: Global Document Commands134558 -Node: documentdescription135314 -Node: setchapternewpage136130 -Node: paragraphindent139016 -Node: firstparagraphindent140290 -Node: exampleindent141558 -Node: Software Copying Permissions142582 -Node: Ending a File143640 -Node: Printing Indices & Menus144215 -Node: File End147315 -Node: Structuring148001 -Node: Tree Structuring149660 -Node: Structuring Command Types151079 -Node: makeinfo top153574 -Node: chapter154365 -Node: unnumbered & appendix155395 -Node: majorheading & chapheading156246 -Node: section157073 -Node: unnumberedsec appendixsec heading157843 -Node: subsection158840 -Node: unnumberedsubsec appendixsubsec subheading159418 -Node: subsubsection160379 -Node: Raise/lower sections161937 -Node: Nodes164113 -Node: Two Paths165323 -Node: Node Menu Illustration166659 -Node: node170467 -Node: Node Names173226 -Node: Writing a Node174610 -Node: Node Line Tips176656 -Node: Node Line Requirements177460 -Node: First Node179617 -Node: makeinfo top command181435 -Node: makeinfo Pointer Creation182716 -Node: anchor184345 -Node: Menus185821 -Node: Menu Location186887 -Node: Writing a Menu188518 -Node: Menu Parts189581 -Node: Less Cluttered Menu Entry190745 -Node: Menu Example191376 -Node: Other Info Files192886 -Node: Cross References194738 -Node: References195709 -Node: Cross Reference Commands197481 -Node: Cross Reference Parts198546 -Node: xref201402 -Node: Reference Syntax202207 -Node: One Argument203844 -Node: Two Arguments204871 -Node: Three Arguments205996 -Node: Four and Five Arguments208397 -Node: Top Node Naming210819 -Node: ref211835 -Node: pxref213256 -Node: inforef215624 -Node: uref216935 -Node: Marking Text219685 -Node: Indicating220338 -Node: Useful Highlighting222478 -Node: code224101 -Node: kbd227343 -Node: key229563 -Node: samp230907 -Node: verb232388 -Node: var233377 -Node: env235351 -Node: file235862 -Node: command236483 -Node: option237189 -Node: dfn237709 -Node: cite238633 -Node: acronym239101 -Node: indicateurl240384 -Node: email241082 -Node: Emphasis241938 -Node: emph & strong242775 -Node: Smallcaps243990 -Node: Fonts245336 -Node: Quotations and Examples246492 -Node: Block Enclosing Commands248177 -Node: quotation250364 -Node: example252002 -Node: verbatim254321 -Node: verbatiminclude256091 -Node: lisp257085 -Ref: lisp-Footnote-1257824 -Node: small257942 -Node: display259473 -Node: format260275 -Node: exdent260921 -Node: flushleft & flushright262011 -Node: noindent263286 -Node: indent265150 -Node: cartouche266194 -Node: Lists and Tables267390 -Node: Introducing Lists268079 -Node: itemize269741 -Node: enumerate272019 -Node: Two-column Tables274517 -Node: table275214 -Node: ftable vtable277892 -Node: itemx278989 -Node: Multi-column Tables280175 -Node: Multitable Column Widths280884 -Node: Multitable Rows282366 -Node: Special Displays284419 -Node: Floats285208 -Node: float286105 -Ref: fig:ex1286779 -Node: caption shortcaption288050 -Node: listoffloats289361 -Node: Images290764 -Node: Image Syntax291199 -Node: Image Scaling293804 -Node: Footnotes295528 -Ref: Footnotes-Footnote-1296094 -Node: Footnote Commands296374 -Ref: Footnote Commands-Footnote-1298251 -Node: Footnote Styles298287 -Node: Indices300902 -Node: Index Entries302116 -Node: Predefined Indices303241 -Node: Indexing Commands305350 -Node: Combining Indices308063 -Node: syncodeindex309416 -Node: synindex311064 -Node: New Indices311601 -Node: Insertions313370 -Node: Atsign Braces Comma314497 -Node: Inserting an Atsign315065 -Node: Inserting Braces315337 -Node: Inserting a Comma315756 -Node: Inserting Space316790 -Node: Not Ending a Sentence317307 -Node: Ending a Sentence318919 -Node: Multiple Spaces319943 -Node: dmn321234 -Node: Inserting Accents322459 -Node: Dots Bullets324462 -Node: dots325278 -Node: bullet325901 -Node: TeX and copyright326310 -Node: tex326986 -Node: copyright symbol327803 -Node: registered symbol328113 -Node: pounds328435 -Node: minus328806 -Node: math329725 -Node: Glyphs331073 -Node: Glyphs Summary332179 -Node: result332804 -Node: expansion333314 -Node: Print Glyph334276 -Node: Error Glyph335168 -Node: Equivalence336022 -Node: Point Glyph336772 -Node: Breaks338343 -Node: Break Commands339827 -Node: Line Breaks340723 -Node: - and hyphenation341697 -Node: w342963 -Node: tie344071 -Node: sp344975 -Node: page345394 -Node: group345779 -Node: need347531 -Node: Definition Commands348269 -Node: Def Cmd Template349920 -Node: Def Cmd Continuation Lines352645 -Node: Optional Arguments354456 -Node: deffnx356063 -Node: Def Cmds in Detail357006 -Node: Functions Commands358124 -Node: Variables Commands361026 -Node: Typed Functions363169 -Node: Typed Variables366674 -Node: Data Types368395 -Node: Abstract Objects369686 -Node: Object-Oriented Variables370293 -Node: Object-Oriented Methods372926 -Node: Def Cmd Conventions376737 -Node: Sample Function Definition377308 -Node: Conditionals380144 -Node: Conditional Commands381338 -Node: Conditional Not Commands383229 -Node: Raw Formatter Commands384513 -Node: set clear value387141 -Node: set value388355 -Node: ifset ifclear389957 -Node: value Example392088 -Node: Conditional Nesting394105 -Node: Internationalization395646 -Node: documentlanguage396182 -Node: documentencoding400369 -Node: Defining New Texinfo Commands401861 -Node: Defining Macros403039 -Node: Invoking Macros405417 -Node: Macro Details407218 -Node: alias409796 -Node: definfoenclose411220 -Node: Hardcopy413968 -Node: Use TeX416044 -Node: Format with tex/texindex416677 -Node: Format with texi2dvi421043 -Node: Print with lpr422614 -Node: Within Emacs424773 -Node: Texinfo Mode Printing425664 -Node: Compile-Command429333 -Node: Requirements Summary430215 -Node: Preparing for TeX431555 -Ref: Preparing for TeX-Footnote-1435308 -Node: Overfull hboxes435407 -Node: smallbook437566 -Node: A4 Paper438772 -Node: pagesizes439708 -Node: Cropmarks and Magnification440902 -Node: PDF Output442971 -Node: Obtaining TeX444127 -Node: Creating and Installing Info Files445104 -Node: Creating an Info File445498 -Node: makeinfo advantages446726 -Node: Invoking makeinfo447662 -Node: makeinfo options448228 -Node: Pointer Validation457295 -Node: makeinfo in Emacs460427 -Node: texinfo-format commands462910 -Node: Batch Formatting464197 -Node: Tag and Split Files465409 -Node: Installing an Info File468806 -Node: Directory File469645 -Node: New Info File471444 -Ref: New Info File-Footnote-1472558 -Node: Other Info Directories472639 -Ref: Other Info Directories-Footnote-1476914 -Ref: Other Info Directories-Footnote-2477041 -Node: Installing Dir Entries477102 -Node: Invoking install-info479764 -Node: Generating HTML482661 -Node: HTML Translation483442 -Node: HTML Splitting484824 -Node: HTML CSS486507 -Node: HTML Xref489996 -Node: HTML Xref Link Basics491203 -Node: HTML Xref Node Name Expansion494026 -Node: HTML Xref Command Expansion496579 -Node: HTML Xref 8-bit Character Expansion499584 -Node: HTML Xref Mismatch500818 -Node: Command List502636 -Node: Command Syntax545467 -Node: Tips548476 -Node: Sample Texinfo Files559473 -Node: Short Sample Texinfo File559939 -Node: GNU Sample Texts561534 -Node: Verbatim Copying License566809 -Node: All-permissive Copying License567911 -Node: Include Files568941 -Node: Using Include Files570052 -Node: texinfo-multiple-files-update572604 -Node: Include Files Requirements574972 -Node: Sample Include File576226 -Node: Include Files Evolution577463 -Node: Headings579443 -Node: Headings Introduced580100 -Node: Heading Format581977 -Node: Heading Choice584421 -Node: Custom Headings585799 -Node: Catching Mistakes589906 -Node: makeinfo Preferred591213 -Node: Debugging with Info592098 -Node: Debugging with TeX595442 -Node: Using texinfo-show-structure599705 -Node: Using occur602795 -Node: Running Info-Validate604336 -Node: Using Info-validate605403 -Node: Unsplit607213 -Node: Tagifying608272 -Node: Splitting609134 -Node: Copying This Manual610762 -Node: GNU Free Documentation License611025 -Node: Command and Variable Index633432 -Node: Concept Index662680 +Node: Top1639 +Node: Copying Conditions26594 +Node: Overview28656 +Ref: Overview-Footnote-130030 +Node: Reporting Bugs30487 +Node: Using Texinfo31751 +Node: Output Formats33335 +Node: Info Files38641 +Ref: Info Files-Footnote-143043 +Node: Printed Books43222 +Ref: Printed Books-Footnote-146064 +Node: Formatting Commands46398 +Ref: Formatting Commands-Footnote-149253 +Node: Conventions49861 +Node: Comments52467 +Node: Minimum54092 +Node: Six Parts56649 +Node: Short Sample58271 +Node: History62410 +Node: Texinfo Mode64456 +Node: Texinfo Mode Overview65828 +Node: Emacs Editing66593 +Node: Inserting68734 +Node: Showing the Structure73001 +Node: Updating Nodes and Menus75319 +Node: Updating Commands76393 +Node: Updating Requirements82390 +Node: Other Updating Commands84774 +Node: Info Formatting88035 +Node: Printing89296 +Node: Texinfo Mode Summary91599 +Node: Beginning a File96276 +Node: Sample Beginning97690 +Node: Texinfo File Header99312 +Node: First Line100771 +Node: Start of Header101797 +Node: setfilename102783 +Node: settitle105283 +Node: End of Header107539 +Node: Document Permissions107818 +Node: copying108444 +Node: insertcopying111112 +Node: Titlepage & Copyright Page112301 +Node: titlepage113975 +Ref: titlepage-Footnote-1116477 +Node: titlefont center sp116763 +Node: title subtitle author118440 +Node: Copyright121209 +Node: end titlepage122732 +Node: headings on off124518 +Node: Contents126483 +Node: The Top Node129708 +Node: Top Node Example130919 +Node: Master Menu Parts131318 +Node: Global Document Commands133123 +Node: documentdescription133874 +Node: setchapternewpage134685 +Node: paragraphindent137566 +Node: firstparagraphindent138835 +Node: exampleindent140098 +Node: Software Copying Permissions141258 +Node: Ending a File142311 +Node: Printing Indices & Menus142881 +Node: File End145976 +Node: Structuring146657 +Node: Tree Structuring148311 +Node: Structuring Command Types149725 +Node: makeinfo top152215 +Node: chapter153001 +Node: unnumbered & appendix154026 +Node: majorheading & chapheading154634 +Node: section155456 +Node: unnumberedsec appendixsec heading156484 +Node: subsection157689 +Node: unnumberedsubsec appendixsubsec subheading158274 +Node: subsubsection159451 +Node: Raise/lower sections161253 +Node: Nodes163424 +Node: Two Paths164629 +Node: Node Menu Illustration165960 +Node: node169763 +Node: Node Names172830 +Node: Writing a Node174269 +Node: Node Line Tips176602 +Node: Node Line Requirements177401 +Node: First Node179553 +Node: makeinfo top command180978 +Node: makeinfo Pointer Creation182254 +Node: anchor184148 +Node: Menus185738 +Node: Menu Location186804 +Node: Writing a Menu188434 +Node: Menu Parts189753 +Node: Less Cluttered Menu Entry190912 +Node: Menu Example191538 +Node: Other Info Files193043 +Node: Cross References194890 +Node: References195856 +Node: Cross Reference Commands197623 +Node: Cross Reference Parts198683 +Node: xref201694 +Node: Reference Syntax202494 +Node: One Argument204126 +Node: Two Arguments205148 +Node: Three Arguments206268 +Node: Four and Five Arguments208664 +Node: Top Node Naming211081 +Node: ref212092 +Node: pxref213679 +Node: inforef216215 +Node: uref217591 +Node: Marking Text220323 +Node: Indicating220971 +Node: Useful Highlighting223173 +Node: code225345 +Node: kbd228765 +Node: key230980 +Node: samp232438 +Node: verb233914 +Node: var235030 +Node: env236999 +Node: file237505 +Node: command238121 +Node: option238822 +Node: dfn239337 +Node: cite240256 +Node: abbr240716 +Node: acronym242142 +Node: indicateurl244473 +Node: email245166 +Node: Emphasis246017 +Node: emph & strong246849 +Node: Smallcaps248059 +Node: Fonts249395 +Node: Quotations and Examples251750 +Node: Block Enclosing Commands253504 +Node: quotation255686 +Node: example257260 +Node: verbatim259574 +Node: verbatiminclude261404 +Node: lisp262518 +Ref: lisp-Footnote-1263252 +Node: small263370 +Node: display264896 +Node: format266000 +Node: exdent266641 +Node: flushleft & flushright267728 +Node: noindent268998 +Node: indent270857 +Node: cartouche271896 +Node: Lists and Tables273087 +Node: Introducing Lists273771 +Node: itemize275428 +Node: enumerate277701 +Node: Two-column Tables280194 +Node: table280886 +Node: ftable vtable283559 +Node: itemx284651 +Node: Multi-column Tables285832 +Node: Multitable Column Widths286536 +Node: Multitable Rows288013 +Node: Special Displays290152 +Node: Floats290936 +Node: float291828 +Ref: fig:ex1292497 +Node: caption shortcaption293769 +Node: listoffloats295352 +Node: Images296750 +Node: Image Syntax297180 +Node: Image Scaling300421 +Node: Footnotes302140 +Ref: Footnotes-Footnote-1302701 +Node: Footnote Commands302981 +Ref: Footnote Commands-Footnote-1304853 +Node: Footnote Styles304889 +Node: Indices307499 +Node: Index Entries308708 +Node: Predefined Indices309828 +Node: Indexing Commands311932 +Node: Combining Indices314640 +Node: syncodeindex315988 +Node: synindex317631 +Node: New Indices318163 +Node: Insertions319927 +Node: Atsign Braces Comma321467 +Node: Inserting an Atsign322041 +Node: Inserting Braces322308 +Node: Inserting a Comma322719 +Node: Inserting Quote Characters323750 +Node: Inserting Space325263 +Node: Not Ending a Sentence325850 +Node: Ending a Sentence327298 +Node: Multiple Spaces328317 +Node: frenchspacing329613 +Node: dmn331551 +Node: Inserting Accents332769 +Node: Inserting Quotation Marks334891 +Node: Dots Bullets338783 +Node: dots339602 +Node: bullet340217 +Node: TeX and copyright340621 +Node: tex341290 +Node: copyright symbol342102 +Node: registered symbol342407 +Node: euro342724 +Node: pounds344260 +Node: textdegree344557 +Node: minus344876 +Node: geq leq345799 +Node: math346188 +Node: Click Sequences348122 +Node: Glyphs349168 +Node: Glyphs Summary350282 +Node: result350904 +Node: expansion351411 +Node: Print Glyph352370 +Node: Error Glyph353259 +Node: Equivalence354110 +Node: Point Glyph354857 +Node: Breaks356425 +Node: Break Commands357979 +Node: Line Breaks358870 +Node: - and hyphenation359839 +Node: allowcodebreaks361165 +Node: w362395 +Node: tie363496 +Node: sp364395 +Node: page364809 +Node: group365189 +Node: need366936 +Node: Definition Commands367671 +Node: Def Cmd Template369317 +Node: Def Cmd Continuation Lines372157 +Node: Optional Arguments373963 +Node: deffnx375565 +Node: Def Cmds in Detail376503 +Node: Functions Commands377616 +Node: Variables Commands380513 +Node: Typed Functions382651 +Node: Typed Variables386151 +Node: Data Types387867 +Node: Abstract Objects389153 +Node: Object-Oriented Variables389755 +Node: Object-Oriented Methods392383 +Node: Def Cmd Conventions396189 +Node: Sample Function Definition396755 +Node: Conditionals399586 +Node: Conditional Commands400775 +Node: Conditional Not Commands402661 +Node: Raw Formatter Commands403940 +Node: set clear value406563 +Node: set value407773 +Node: ifset ifclear409370 +Node: value Example411496 +Node: Conditional Nesting413508 +Node: Internationalization415044 +Node: documentlanguage415575 +Node: documentencoding418368 +Node: Defining New Texinfo Commands421345 +Node: Defining Macros422518 +Node: Invoking Macros424891 +Node: Macro Details428275 +Node: alias432306 +Node: definfoenclose433725 +Node: Hardcopy436467 +Node: Use TeX438538 +Node: Format with tex/texindex439166 +Node: Format with texi2dvi443470 +Node: Print with lpr446979 +Node: Within Emacs449133 +Node: Texinfo Mode Printing450019 +Node: Compile-Command453683 +Node: Requirements Summary454560 +Node: Preparing for TeX455895 +Ref: Preparing for TeX-Footnote-1459910 +Node: Overfull hboxes460009 +Node: smallbook462163 +Node: A4 Paper463364 +Node: pagesizes464295 +Node: Cropmarks and Magnification465484 +Node: PDF Output467548 +Node: Obtaining TeX469129 +Node: Creating and Installing Info Files470103 +Node: Creating an Info File470492 +Node: makeinfo advantages471715 +Node: Invoking makeinfo472646 +Node: makeinfo options473207 +Node: Pointer Validation482812 +Node: makeinfo in Emacs486000 +Node: texinfo-format commands488478 +Node: Batch Formatting489760 +Node: Tag and Split Files490967 +Node: Installing an Info File494359 +Node: Directory File495193 +Node: New Info File496987 +Ref: New Info File-Footnote-1498096 +Node: Other Info Directories498177 +Ref: Other Info Directories-Footnote-1502447 +Ref: Other Info Directories-Footnote-2502574 +Node: Installing Dir Entries502635 +Node: Invoking install-info505826 +Node: Generating HTML512434 +Node: HTML Translation513210 +Node: HTML Splitting514587 +Node: HTML CSS516265 +Node: HTML Xref519949 +Node: HTML Xref Link Basics521151 +Node: HTML Xref Node Name Expansion524191 +Node: HTML Xref Command Expansion527282 +Node: HTML Xref 8-bit Character Expansion530334 +Node: HTML Xref Mismatch532667 +Node: Command List534480 +Node: Command Syntax578272 +Node: Tips581154 +Node: Sample Texinfo Files592146 +Node: Short Sample Texinfo File592607 +Node: GNU Sample Texts594197 +Node: Verbatim Copying License599694 +Node: All-permissive Copying License600790 +Node: Include Files601815 +Node: Using Include Files602921 +Node: texinfo-multiple-files-update605468 +Node: Include Files Requirements607831 +Node: Sample Include File609080 +Node: Include Files Evolution610312 +Node: Headings612287 +Node: Headings Introduced612939 +Node: Heading Format614811 +Node: Heading Choice617250 +Node: Custom Headings618623 +Node: Catching Mistakes624284 +Node: makeinfo Preferred625597 +Node: Debugging with Info626477 +Node: Debugging with TeX629816 +Node: Using texinfo-show-structure634074 +Node: Using occur637159 +Node: Running Info-Validate638695 +Node: Using Info-validate639757 +Node: Unsplit641562 +Node: Tagifying642616 +Node: Splitting643473 +Node: GNU Free Documentation License645096 +Node: Command and Variable Index667546 +Node: General Index700891 End Tag Table |