Mercurial > hg > xemacs-beta
diff man/texinfo.texi @ 70:131b0175ea99 r20-0b30
Import from CVS: tag r20-0b30
| author | cvs |
|---|---|
| date | Mon, 13 Aug 2007 09:02:59 +0200 |
| parents | ee648375d8d6 |
| children | 360340f9fd5f |
line wrap: on
line diff
--- a/man/texinfo.texi Mon Aug 13 09:00:04 2007 +0200 +++ b/man/texinfo.texi Mon Aug 13 09:02:59 2007 +0200 @@ -1,57 +1,60 @@ \input texinfo.tex @c -*-texinfo-*- -@c $Id: texinfo.texi,v 1.4 1997/08/30 03:56:40 steve Exp $ -@c %**start of header - -@c All text is ignored before the setfilename. -@setfilename texinfo +@comment %**start of header +@setfilename ../info/texinfo.info @settitle Texinfo @value{edition} - -@set edition 2.24 -@set update-month July 1997 -@set update-date 25 @value{update-month} - -@c Define a new index for options. -@defcodeindex op -@c Put everything except function (command, in this case) names in one -@c index (arbitrarily chosen to be the concept index). -@syncodeindex op cp -@syncodeindex vr cp -@syncodeindex pg cp - +@syncodeindex vr fn @footnotestyle separate @paragraphindent 2 -@finalout +@smallbook @comment %**end of header -@c Before release, run C-u C-c C-u C-a (texinfo-all-menus-update with a -@c prefix arg). This updates the node pointers, which texinfmt.el needs. - -@dircategory Texinfo documentation system -@direntry -* Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. Updating info/dir entries. -* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation. -* texindex: (texinfo)Format with tex/texindex. Sorting Texinfo index files. -* makeinfo: (texinfo)makeinfo Preferred. Translate Texinfo source. -@end direntry - @c Set smallbook if printing in smallbook format so the example of the @c smallbook font is actually written using smallbook; in bigbook, a kludge -@c is used for TeX output. Do this through the -t option to texi2dvi, -@c so this same source can be used for other paper sizes as well. -@c smallbook -@c set smallbook +@c is used for TeX output. +@set smallbook @c @@clear smallbook +@ignore +@ifinfo +@format +START-INFO-DIR-ENTRY +* Texinfo: (texinfo). The documentation format for the GNU Project. +END-INFO-DIR-ENTRY +@end format +@end ifinfo +@end ignore + +@set edition 2.21 +@set update-date 7 June 1995 +@set update-month June 1995 + +@c Experiment with smaller amounts of whitespace between chapters +@c and sections. +@tex +\global\chapheadingskip = 15pt plus 4pt minus 2pt +\global\secheadingskip = 12pt plus 3pt minus 2pt +\global\subsecheadingskip = 9pt plus 2pt minus 2pt +@end tex + +@c Experiment with smaller amounts of whitespace between paragraphs in +@c the 8.5 by 11 inch format. +@ifclear smallbook +@tex +\global\parskip 6pt plus 1pt +@end tex +@end ifclear + +@finalout + @c Currently undocumented command, 5 December 1993: @c @c nwnode (Same as node, but no warnings; for `makeinfo'.) @ifinfo -This file documents Texinfo, a documentation system that can produce -both on-line information and a printed manual from a single source file. - -Copyright (C) 1988, 90, 91, 92, 93, 95, 96, 97 Free Software Foundation, Inc. +This file documents Texinfo, a documentation system that uses a single +source file to produce both on-line information and a printed manual. + +Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995 Free Software Foundation, Inc. This is the second edition of the Texinfo documentation,@* and is consistent with version 2 of @file{texinfo.tex}. @@ -89,16 +92,14 @@ @subtitle Edition @value{edition}, for Texinfo Version Three @subtitle @value{update-month} -@author Robert J.@: Chassell -@author Richard M.@: Stallman - -@c Include the Distribution inside the titlepage so -@c that headings are turned off. +@author by Robert J. Chassell and Richard M. Stallman + +@comment Include the Distribution inside the titlepage so +@c that headings are turned off. @page @vskip 0pt plus 1filll -Copyright @copyright{} 1988, 90, 91, 92, 93, 95, 96, 97 -Free Software Foundation, Inc. +Copyright @copyright{} 1988, 1990, 1991, 1992, 1993, 1995 Free Software Foundation, Inc. @sp 2 This is the second edition of the Texinfo documentation,@* @@ -106,13 +107,11 @@ @sp 2 Published by the Free Software Foundation @* -59 Temple Place Suite 330 @* -Boston, MA 02111-1307 @* -USA @* +59 Temple Place Suite 330, @* +Boston, MA 02111-1307 USA @* Printed copies are available for $15 each.@* -ISBN 1-882114-64-7 -@c ISBN 1-882114-63-9 is for edition 2.20 of 28 February 1995 -@c ISBN 1-882114-64-7 is for edition 2.23 of 1 October 1996. +ISBN 1-882114-63-9 +@c ISBN number 1-882114-63-9 is for edition 2.20 of 28 February 1995 Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -142,12 +141,12 @@ document, including the @@-command and concept indices. The rest of the menu lists all the lower level nodes in the document.@refill -This is Edition @value{edition} of the Texinfo documentation, +This is Edition @value{edition} of the Texinfo documentation, @w{@value{update-date},} for Texinfo Version Three. @end ifinfo @c Here is a spare copy of the chapter menu entry descriptions, -@c in case they are accidently deleted +@c in case they are accidently deleted @ignore Your rights. Texinfo in brief. @@ -192,7 +191,7 @@ @end ignore @menu -* Copying:: Your rights. +* Copying:: Your rights. * Overview:: Texinfo in brief. * Texinfo Mode:: How to use Texinfo mode. * Beginning a File:: What is at the beginning of a Texinfo file? @@ -209,12 +208,13 @@ * Lists and Tables:: How to write lists and tables. * Indices:: How to create indices. * Insertions:: How to insert @@-signs, braces, etc. +* Glyphs:: How to indicate results of evaluation, + expansion of macros, errors, etc. * Breaks:: How to force and prevent line and page breaks. -* Definition Commands:: How to describe functions and the like +* Definition Commands:: How to describe functions and the like in a uniform manner. * Footnotes:: How to write footnotes. * Conditionals:: How to specify text for either @TeX{} or Info. -* Macros:: Defining new Texinfo commands. * Format/Print Hardcopy:: How to convert a Texinfo file to a file for printing and how to print that file. * Create an Info File:: Convert a Texinfo file into an Info file. @@ -230,16 +230,15 @@ * Refilling Paragraphs:: All about paragraph refilling. * Command Syntax:: A description of @@-Command syntax. * Obtaining TeX:: How to Obtain @TeX{}. +* New Features:: Texinfo second edition features. * Command and Variable Index:: A menu containing commands and variables. * Concept Index:: A menu covering many topics. -@detailmenu - --- The Detailed Node Listing --- Overview of Texinfo -* Using Texinfo:: Create a conventional printed book +* Using Texinfo:: Create a conventional printed book or an Info file. * Info Files:: What is an Info file? * Printed Books:: Characteristics of a printed book or manual. @@ -257,7 +256,7 @@ * Texinfo Mode Overview:: How Texinfo mode can help you. * Emacs Editing:: Texinfo mode adds to GNU Emacs' general purpose editing features. -* Inserting:: How to insert frequently used @@-commands. +* Inserting:: How to insert frequently used @@-commands. * Showing the Structure:: How to show the structure of a file. * Updating Nodes and Menus:: How to update or create new nodes and menus. * Info Formatting:: How to format for Info. @@ -286,7 +285,7 @@ The Texinfo File Header -* First Line:: The first line of a Texinfo file. +* First Line:: The first line of a Texinfo file. * Start of Header:: Formatting a region requires this. * setfilename:: Tell Info the name of the Info file. * settitle:: Create a title for the printed work. @@ -315,7 +314,7 @@ Ending a Texinfo File -* Printing Indices & Menus:: How to print an index in hardcopy and +* Printing Indices & Menus:: How to print an index in hardcopy and generate index menus in Info. * Contents:: How to create a table of contents. * File End:: How to mark the end of a file. @@ -337,7 +336,7 @@ Nodes -* Two Paths:: Different commands to structure +* Two Paths:: Different commands to structure Info output and printed output. * Node Menu Illustration:: A diagram, and sample nodes and menus. * node:: How to write a node, in detail. @@ -350,7 +349,7 @@ * Node Line Tips:: Keep names short. * Node Line Requirements:: Keep names unique, without @@-commands. * First Node:: How to write a `Top' node. -* makeinfo top command:: How to use the @code{@@top} command. +* makeinfo top command:: How to use the @code{@@top} command. * Top Node Summary:: Write a brief description for readers. Menus @@ -372,7 +371,6 @@ * ref:: A reference for the last part of a sentence. * pxref:: How to write a parenthetical cross reference. * inforef:: How to refer to an Info-only file. -* uref:: How to refer to a uniform resource locator. @code{@@xref} @@ -398,8 +396,6 @@ * file:: How to indicate the name of a file. * dfn:: How to specify a definition. * cite:: How to refer to a book that is not in Info. -* url:: How to indicate a world wide web reference. -* email:: How to indicate an electronic mail address. Emphasizing Text @@ -410,7 +406,7 @@ Quotations and Examples -* Block Enclosing Commands:: Use different constructs for +* Block Enclosing Commands:: Use different constructs for different purposes. * quotation:: How to write a quotation. * example:: How to write an example in a fixed-width font. @@ -424,25 +420,20 @@ * flushleft & flushright:: How to push text flushleft or flushright. * cartouche:: How to draw cartouches around examples. -Lists and Tables +Making Lists and Tables * Introducing Lists:: Texinfo formats lists for you. * itemize:: How to construct a simple list. * enumerate:: How to construct a numbered list. * Two-column Tables:: How to construct a two-column table. -* Multi-column Tables:: How to construct generalized tables. Making a Two-column Table * table:: How to construct a two-column table. -* ftable vtable:: Automatic indexing for two-column tables. +* ftable vtable:: How to construct a two-column table + with automatic indexing. * itemx:: How to put more entries in the first column. -Multi-column Tables - -* Multitable Column Widths:: Defining multitable column widths. -* Multitable Rows:: Defining multitable rows, with examples. - Creating Indices * Index Entries:: Choose different words for index entries. @@ -461,31 +452,20 @@ Special Insertions -* Braces Atsigns:: How to insert braces, @samp{@@}. -* Inserting Space:: How to insert the right amount of space - within a sentence. -* Inserting Accents:: How to insert accents and special characters. +* Braces Atsigns Periods:: How to insert braces, @samp{@@} and periods. +* dmn:: How to format a dimension. * Dots Bullets:: How to insert dots and bullets. -* TeX and copyright:: How to insert the @TeX{} logo +* TeX and copyright:: How to insert the @TeX{} logo and the copyright symbol. -* pounds:: How to insert the pounds currency symbol. * minus:: How to insert a minus sign. * math:: How to format a mathematical expression. -* Glyphs:: How to indicate results of evaluation, - expansion of macros, errors, etc. -* Images:: How to include graphics. - -Inserting @@ and Braces - -* Inserting An Atsign:: How to insert @samp{@@}. -* Inserting Braces:: How to insert @samp{@{} and @samp{@}}. - -Inserting Space - -* Not Ending a Sentence:: Sometimes a . doesn't end a sentence. -* Ending a Sentence:: Sometimes it does. -* Multiple Spaces:: Inserting multiple spaces. -* dmn:: How to format a dimension. + +Inserting @samp{@@}, Braces, and Periods + +* Inserting An Atsign:: +* Inserting Braces:: How to insert @samp{@{} and @samp{@}} +* Controlling Spacing:: How to insert the right amount of space + after punctuation within a sentence. Inserting Ellipsis, Dots, and Bullets @@ -497,7 +477,7 @@ * tex:: How to insert the @TeX{} logo. * copyright symbol:: How to use @code{@@copyright}@{@}. -Glyphs for Examples +Glyphs for Examples * Glyphs Summary:: * result:: How to show the result of expression. @@ -507,21 +487,11 @@ * Equivalence:: How to indicate equivalence. * Point Glyph:: How to indicate the location of point. -Glyphs Summary - -* result:: -* expansion:: -* Print Glyph:: -* Error Glyph:: -* Equivalence:: -* Point Glyph:: - Making and Preventing Breaks * Break Commands:: Cause and prevent splits. * Line Breaks:: How to force a single line to use two lines. -* - and hyphenation:: How to tell TeX about hyphenation points. -* w:: How to prevent unwanted line breaks. +* w:: How to prevent unwanted line breaks. * sp:: How to insert blank lines. * page:: How to force the start of a new page. * group:: How to prevent unwanted page breaks. @@ -546,31 +516,20 @@ * Abstract Objects:: Commands for object-oriented programming. * Data Types:: The definition command for data types. -Footnotes - -* Footnote Commands:: How to write a footnote in Texinfo. -* Footnote Styles:: Controlling how footnotes appear in Info. - Conditionally Visible Text -* Conditional Commands:: Specifying text for HTML, Info, or @TeX{}. -* Conditional Not Commands:: Specifying text for not HTML, Info, or @TeX{}. -* Raw Formatter Commands:: Using raw @TeX{} or HTML commands. -* set clear value:: Designating which text to format (for - all output formats); and how to set a +* Conditional Commands:: How to specify text for Info or @TeX{}. +* Using Ordinary TeX Commands:: You can use any and all @TeX{} commands. +* set clear value:: How to designate which text to format (for + both Info and @TeX{}); and how to set a flag to a string that you can insert. @code{@@set}, @code{@@clear}, and @code{@@value} * ifset ifclear:: Format a region if a flag is set. -* value:: Replace a flag with a string. +* value:: Replace a flag with a string. * value Example:: An easy way to update edition information. -Macros: Defining New Texinfo Commands - -* Defining Macros:: Both defining and undefining new commands. -* Invoking Macros:: Using a macro, once you've defined it. - Format and Print Hardcopy * Use TeX:: Use @TeX{} to format for hardcopy. @@ -596,21 +555,18 @@ * Pointer Validation:: How to check that pointers point somewhere. * makeinfo in Emacs:: How to run @code{makeinfo} from Emacs. * texinfo-format commands:: Two Info formatting commands written - in Emacs Lisp are an alternative + in Emacs Lisp are an alternative to @code{makeinfo}. * Batch Formatting:: How to format for Info in Emacs Batch mode. -* Tag and Split Files:: How tagged and split files help Info +* Tag and Split Files:: How tagged and split files help Info to run better. Installing an Info File * Directory file:: The top level menu for all Info files. * New Info File:: Listing a new info file. -* Other Info Directories:: How to specify Info files that are +* Other Info Directories:: How to specify Info files that are located in other directories. -* Installing Dir Entries:: How to specify what menu entry to add - to the Info directory. -* Invoking install-info:: @code{install-info} options. Sample Permissions @@ -638,7 +594,7 @@ Formatting Mistakes -* makeinfo Preferred:: @code{makeinfo} finds errors. +* makeinfo preferred:: @code{makeinfo} finds errors. * Debugging with Info:: How to catch errors with Info formatting. * Debugging with TeX:: How to catch errors with @TeX{} formatting. * Using texinfo-show-structure:: How to use @code{texinfo-show-structure}. @@ -652,11 +608,10 @@ * Tagifying:: How to tagify a file. * Splitting:: How to split a file manually. -How to Obtain @TeX{} +Second Edition Features * New Texinfo Mode Commands:: The updating commands are especially useful. * New Commands:: Many newly described @@-commands. -@end detailmenu @end menu @node Copying, Overview, Top, Top @@ -713,7 +668,7 @@ rather than the English letter ``ex''. Pronounce @TeX{} as if the @samp{X} were the last sound in the name `Bach'; but pronounce Texinfo as if the @samp{x} were a `k'. Spell ``Texinfo'' with a capital ``T'' -and write the other letters in lower case.} +and write the other letters in lower case.} is a documentation system that uses a single source file to produce both on-line information and printed output. This means that instead of writing two different documents, one for the on-line help or other on-line @@ -723,7 +678,7 @@ @dfn{Info file}, with an Info documentation-reading program.)@refill @menu -* Using Texinfo:: Create a conventional printed book +* Using Texinfo:: Create a conventional printed book or an Info file. * Info Files:: What is an Info file? * Printed Books:: Characteristics of a printed book or manual. @@ -753,17 +708,18 @@ Emacs Manual} is a good example of a Texinfo file, as is this manual.@refill To make a printed document, you process a Texinfo source file with the -@TeX{} typesetting program. This creates a DVI file that you can -typeset and print as a book or report. (Note that the Texinfo language -is completely different from @TeX{}'s usual language, plain @TeX{}.) If -you do not have @TeX{}, but do have @code{troff} or @code{nroff}, you -can use the @code{texi2roff} program instead.@refill +@TeX{} typesetting program. This creates a @sc{dvi} file that you can +typeset and print as a book or report. (Note that the Texinfo language is +completely different from @TeX{}'s usual language, Plain@TeX{}, which +Texinfo replaces.) If you do not have @TeX{}, but do have +@code{troff} or @code{nroff}, you can use the @code{texi2roff} program +instead.@refill To make an Info file, you process a Texinfo source file with the @code{makeinfo} utility or Emacs's @code{texinfo-format-buffer} command; this creates an Info file that you can install on-line.@refill -@TeX{} and @code{texi2roff} work with many types of printers; similarly, +@TeX{} and @code{texi2roff} work with many types of printer; similarly, Info works with almost every type of computer terminal. This power makes Texinfo a general purpose system, but brings with it a constraint, which is that a Texinfo file may contain only the customary @@ -817,7 +773,7 @@ is at the logical level of a chapter, its child nodes are at the level of sections; likewise, the child nodes of sections are at the level of subsections.@refill - + All the children of any one parent are linked together in a bidirectional chain of `Next' and `Previous' pointers. The `Next' pointer provides a link to the next section, and the `Previous' pointer @@ -845,33 +801,33 @@ represent links that do not fit a hierarchical structure.@refill Usually, you will design a document so that its nodes match the -structure of chapters and sections in the printed output. But -occasionally there are times when this is not right for the material -being discussed. Therefore, Texinfo uses separate commands to specify -the node structure for the Info file and the section structure for the -printed output.@refill +structure of chapters and sections in the printed output. But there +are times when this is not right for the material being discussed. +Therefore, Texinfo uses separate commands to specify the node +structure for the Info file and the section structure for the printed +output.@refill Generally, you enter an Info file through a node that by convention is -named `Top'. This node normally contains just a brief summary of the -file's purpose, and a large menu through which the rest of the file is -reached. From this node, you can either traverse the file +called @samp{Top}. This node normally contains just a brief summary +of the file's purpose, and a large menu through which the rest of the +file is reached. From this node, you can either traverse the file systematically by going from node to node, or you can go to a specific -node listed in the main menu, or you can search the index menus and then -go directly to the node that has the information you want. Alternatively, -with the standalone Info program, you can specify specific menu items on -the command line (@pxref{Top,,, info, Info}). +node listed in the main menu, or you can search the index menus and +then go directly to the node that has the information you want.@refill +@c !!! With the standalone Info system you may go to specific nodes +@c directly.. If you want to read through an Info file in sequence, as if it were a -printed manual, you can hit @key{SPC} repeatedly, or you get the whole -file with the advanced Info command @kbd{g *}. (@inforef{Expert, -Advanced Info commands, info}.)@refill +printed manual, you can get the whole file with the advanced Info +command @kbd{g* @key{RET}}. (@inforef{Expert, Advanced Info commands, +info}.)@refill @c !!! dir file may be located in one of many places: @c /usr/local/emacs/info mentioned in info.c DEFAULT_INFOPATH @c /usr/local/lib/emacs/info mentioned in info.c DEFAULT_INFOPATH @c /usr/gnu/info mentioned in info.c DEFAULT_INFOPATH @c /usr/local/info -@c /usr/local/lib/info +@c /usr/local/lib/info The @file{dir} file in the @file{info} directory serves as the departure point for the whole Info system. From it, you can reach the `Top' nodes of each of the documents in a complete Info system.@refill @@ -885,13 +841,12 @@ @cindex Texinfo printed book characteristics @cindex Characteristics, printed books or manuals -@cindex Knuth, Donald A Texinfo file can be formatted and typeset as a printed book or manual. To do this, you need @TeX{}, a powerful, sophisticated typesetting program written by Donald Knuth.@footnote{You can also use the @code{texi2roff} program if you do not have @TeX{}; since Texinfo is designed for use with @TeX{}, @code{texi2roff} is not described here. -@code{texi2roff} is not part of the standard GNU distribution.} +@code{texi2roff} is part of the standard GNU distribution.}@refill A Texinfo-based book is similar to any other typeset, printed work: it can have a title page, copyright page, table of contents, and preface, @@ -910,7 +865,7 @@ (@file{texinfo.tex} tells @TeX{} how to convert the Texinfo @@-commands to @TeX{} commands, which @TeX{} can then process to create the typeset document.) @file{texinfo.tex} contains the specifications for printing -a document.@refill +a document.@refill Most often, documents are printed on 8.5 inch by 11 inch pages (216@dmn{mm} by 280@dmn{mm}; this is the default size), but you @@ -927,7 +882,7 @@ specifications, you can make a book look dignified, old and serious, or light-hearted, young and cheery.@refill -@TeX{} is freely distributable. It is written in a superset of Pascal +@TeX{} is freely distributable. It is written in a dialect of Pascal called WEB and can be compiled either in Pascal or (by using a conversion program that comes with the @TeX{} distribution) in C. (@xref{TeX Mode, ,@TeX{} Mode, emacs, The GNU Emacs Manual}, for information @@ -1032,7 +987,7 @@ @cindex Syntactic conventions @cindex Conventions, syntactic -All printable @sc{ascii} characters except @samp{@@}, @samp{@{} and +All @sc{ascii} printing characters except @samp{@@}, @samp{@{} and @samp{@}} can appear in a Texinfo file and stand for themselves. @samp{@@} is the escape character which introduces commands. @samp{@{} and @samp{@}} should be used only to surround arguments to @@ -1054,14 +1009,14 @@ convention should be followed in Texinfo files. @TeX{} converts doubled single-quote characters to left- and right-hand doubled quotation marks, ``like this'', and Info converts doubled single-quote -characters to @sc{ascii} double-quotes: @w{@tt{ `` }} and +characters to @sc{ascii} double-quotes: @w{@tt{ `` }} and @w{@tt{ '' }} to @w{@tt{ " }}.@refill @end iftex Use three hyphens in a row, @samp{---}, for a dash---like this. In -@TeX{}, a single or double hyphen produces a printed dash that is -shorter than the usual typeset dash. Info reduces three hyphens to two -for display on the screen. +@TeX{}, a single or even a double hyphen produces a printed dash that +is shorter than the usual typeset dash. Info reduces three hyphens to two for +display on the screen.@refill To prevent a paragraph from being indented in the printed manual, put the command @code{@@noindent} on a line by itself before the @@ -1070,24 +1025,18 @@ If you mark off a region of the Texinfo file with the @code{@@iftex} and @w{@code{@@end iftex}} commands, that region will appear only in the printed copy; in that region, you can use certain commands -borrowed from plain @TeX{} that you cannot use in Info. Likewise, if +borrowed from Plain@TeX{} that you cannot use in Info. Likewise, if you mark off a region with the @code{@@ifinfo} and @code{@@end ifinfo} commands, that region will appear only in the Info file; in that region, you can use Info commands that you cannot use in @TeX{}. -Similarly for @code{@@ifhtml @dots{} @@end ifhtml}, -@code{@@ifnothtml @dots{} @@end ifnothtml}, -@code{@@ifnotinfo @dots{} @@end ifnotinfo}, -@code{@@ifnottex @dots{} @@end ifnottex}, -@xref{Conditionals}. +(@xref{Conditionals}.) @cindex Tabs; don't use! @quotation @strong{Caution:} Do not use tabs in a Texinfo file! @TeX{} uses variable-width fonts, which means that it cannot predefine a tab to work in all circumstances. Consequently, @TeX{} treats tabs like single -spaces, and that is not what they look like. Furthermore, -@code{makeinfo} does nothing special with tabs, and thus a tab character -in your input file may appear differently in the output. +spaces, and that is not what they look like.@refill @noindent To avoid this problem, Texinfo mode causes GNU Emacs to insert multiple @@ -1096,9 +1045,6 @@ @noindent Also, you can run @code{untabify} in Emacs to convert tabs in a region to multiple spaces.@refill - -@noindent -Don't use tabs. @end quotation @node Comments, Minimum, Conventions, Overview @@ -1111,7 +1057,7 @@ Such comments are for the person who reads the Texinfo file. All the text on a line that follows either @code{@@comment} or @code{@@c} is a comment; the rest of the line does not appear in either the Info file -or the printed manual. (Often, you can write the @code{@@comment} or +or the printed manual. (Often, you can write the @code{@@comment} or @code{@@c} in the middle of a line, and only the text that follows after the @code{@@comment} or @code{@@c} command does not appear; but some commands, such as @code{@@settitle} and @code{@@setfilename}, work on a @@ -1159,8 +1105,8 @@ reader the nature of the file. The shorter extensions are for operating systems that cannot handle long file names.@refill -In order to be made into a printed manual and an Info file, a Texinfo -file @strong{must} begin with lines like this:@refill +In order to be made into a printed manual and an Info file, a +Texinfo file @strong{must} begin with lines like this:@refill @example @group @@ -1184,9 +1130,9 @@ @file{texinfo.tex} file, which tells @TeX{} how to translate the Texinfo @@-commands into @TeX{} typesetting commands. (Note the use of the backslash, @samp{\}; this is correct for @TeX{}.) The -@samp{@@setfilename} line provides a name for the Info file and tells -@TeX{} to open auxiliary files. The @samp{@@settitle} line specifies a -title for the page headers (or footers) of the printed manual.@refill +@samp{@@setfilename} line provides a name for the Info file and the +@samp{@@settitle} line specifies a title for the page headers (or +footers) of the printed manual.@refill The @code{@@bye} line at the end of the file on a line of its own tells the formatters that the file is ended and to stop formatting.@refill @@ -1207,7 +1153,7 @@ @noindent In the first line, @samp{-*-texinfo-*-} causes Emacs to switch into -Texinfo mode when you edit the file. +Texinfo mode when you edit the file. The @code{@@c} lines which surround the @samp{@@setfilename} and @samp{@@settitle} lines are optional, but you need them in order to @@ -1238,7 +1184,7 @@ @code{@@end ifinfo} commands so that the formatters place it only in the Info file.@refill -@item 3. Title and Copyright +@item 3. Title and Copyright The @dfn{Title and Copyright} segment contains the title and copyright pages and copying permissions for the printed manual. The segment must be enclosed between @code{@@titlepage} and @code{@@end titlepage} commands. @@ -1263,7 +1209,7 @@ @section A Short Sample Texinfo File @cindex Sample Texinfo file -Here is a complete but very short Texinfo file, in six parts. The first +Here is a complete but very short Texinfo file, in 6 parts. The first three parts of the file, from @samp{\input texinfo} through to @samp{@@end titlepage}, look more intimidating than they are. Most of the material is standard boilerplate; when you write a manual, simply @@ -1272,19 +1218,19 @@ @noindent In the following, the sample text is @emph{indented}; comments on it are -not. The complete file, without any comments, is shown in -@ref{Sample Texinfo File}. +not. The complete file, without any comments, is shown in +@ref{Sample Texinfo File}. @subheading Part 1: Header @noindent -The header does not appear in either the Info file or the -printed output. It sets various parameters, including the +The header does not appear in either the Info file or the@* +printed output. It sets various parameters, including the@* name of the Info file and the title used in the header. @example @group -\input texinfo @@c -*-texinfo-*- +\input texinfo @@c -*-texinfo-*- @@c %**start of header @@setfilename sample.info @@settitle Sample Document @@ -1297,7 +1243,7 @@ @subheading Part 2: Summary Description and Copyright @noindent -The summary description and copyright segment does not +The summary description and copyright segment does not@* appear in the printed document. @example @@ -1335,13 +1281,13 @@ @subheading Part 4: `Top' Node and Master Menu @noindent -The `Top' node contains the master menu for the Info file. -Since a printed manual uses a table of contents rather than +The `Top' node contains the master menu for the Info file.@* +Since a printed manual uses a table of contents rather than@* a menu, the master menu appears only in the Info file. @example @group -@@node Top, First Chapter, , (dir) +@@node Top, First Chapter, (dir), (dir) @@comment node-name, next, previous, up @end group @end example @@ -1349,7 +1295,7 @@ @example @group @@menu -* First Chapter:: The first chapter is the +* First Chapter:: The first chapter is the only chapter in this sample. * Concept Index:: This index has two entries. @@end menu @@ -1372,7 +1318,7 @@ @end group @group -This is the contents of the first chapter. +This is the contents of the first chapter. @@cindex Another sample index entry @end group @@ -1390,8 +1336,8 @@ @group The @@code@{makeinfo@} and @@code@{texinfo-format-buffer@} -commands transform a Texinfo file such as this into -an Info file; and @@TeX@{@} typesets it for a printed +commands transform a Texinfo file such as this into +an Info file; and @@TeX@{@} typesets it for a printed manual. @end group @end example @@ -1426,7 +1372,7 @@ @sp 1 @need 700 @quotation -This is the contents of the first chapter. +This is the contents of the first chapter. Here is a numbered list. @@ -1438,9 +1384,9 @@ This is the second item. @end enumerate -The @code{makeinfo} and @code{texinfo-format-buffer} -commands transform a Texinfo file such as this into -an Info file; and @TeX{} typesets it for a printed +The @code{makeinfo} and @code{texinfo-format-buffer} +commands transform a Texinfo file such as this into +an Info file; and @TeX{} typesets it for a printed manual. @end quotation @@ -1448,34 +1394,33 @@ @comment node-name, next, previous, up @section Acknowledgements -@cindex Stallman, Richard M. -@cindex Chassell, Robert J. -@cindex Berry, Karl -Richard M.@: Stallman wrote Edition 1.0 of this manual. @w{Robert J.@: -Chassell} revised and extended it, starting with Edition 1.1. Karl -Berry made updates for the Texinfo 3.8 and subsequent releases, starting -with Edition 2.22. - -@cindex Pinard, Fran@,{c}ois -@cindex Zuhn, David D. -@cindex Weisshaus, Melissa +Richard M.@: Stallman wrote Edition 1.0 of this manual. +@w{Robert J.@: Chassell} revised and extended it, +starting with Edition 1.1. + Our thanks go out to all who helped improve this work, particularly to -Fran@,{c}ois Pinard and @w{David D.@: Zuhn}, who tirelessly recorded and -reported mistakes and obscurities; our special thanks go to Melissa -Weisshaus for her frequent and often tedious reviews of nearly similar -editions. Our mistakes are our own. - +@w{Francois Pinard} and @w{David D.@: Zuhn}, who tirelessly recorded +and reported mistakes and obscurities; our special thanks go to +@w{Melissa Weisshaus} for her frequent and often tedious reviews of +nearly similar editions. Our mistakes are our own. + +@c ignore until mailing lists set up +@ignore Please send suggestions and corrections to: @example @group @r{Internet address:} bug-texinfo@@prep.ai.mit.edu -@end group -@end example - -@noindent -Please include the manual's edition number and update date in your messages. + +@r{UUCP path:} + mit-eddie!prep.ai.mit.edu!bug-texinfo +@end group +@end example + +@noindent +Please include the manual's edition number in your messages. +@end ignore @node Texinfo Mode, Beginning a File, Overview, Top @comment node-name, next, previous, up @@ -1501,7 +1446,7 @@ * Texinfo Mode Overview:: How Texinfo mode can help you. * Emacs Editing:: Texinfo mode adds to GNU Emacs' general purpose editing features. -* Inserting:: How to insert frequently used @@-commands. +* Inserting:: How to insert frequently used @@-commands. * Showing the Structure:: How to show the structure of a file. * Updating Nodes and Menus:: How to update or create new nodes and menus. * Info Formatting:: How to format for Info. @@ -1510,7 +1455,7 @@ @end menu @node Texinfo Mode Overview, Emacs Editing, Texinfo Mode, Texinfo Mode -@ifinfo +@ifinfo @heading Texinfo Mode Overview @end ifinfo @@ -1518,7 +1463,7 @@ files:@refill @itemize @bullet -@item +@item Insert frequently used @@-commands. @refill @item @@ -1528,7 +1473,7 @@ Show the structure of a Texinfo source file.@refill @item -Automatically create or update the `Next', +Automatically create or update the `Next',@* `Previous', and `Up' pointers of a node. @item @@ -1537,7 +1482,7 @@ @item Automatically create a master menu.@refill -@item +@item Format a part or all of a file for Info.@refill @item @@ -1548,7 +1493,7 @@ used @@-commands and for creating node pointers and menus.@refill @node Emacs Editing, Inserting, Texinfo Mode Overview, Texinfo Mode -@section The Usual GNU Emacs Editing Commands +@section The Usual GNU Emacs Editing Commands In most cases, the usual Text mode commands work the same in Texinfo mode as they do in Text mode. Texinfo mode adds new editing commands @@ -1576,9 +1521,9 @@ preferred, since it is explicit, but a shorter extension may be necessary for operating systems that limit the length of file names. GNU Emacs automatically enters Texinfo mode when you visit a file with -a @file{.texinfo} or @file{.texi} -extension. Also, Emacs switches to Texinfo mode -when you visit a +a @file{.texinfo} or @file{.texi} +extension. Also, Emacs switches to Texinfo mode +when you visit a file that has @samp{-*-texinfo-*-} in its first line. If ever you are in another mode and wish to switch to Texinfo mode, type @code{M-x texinfo-mode}.@refill @@ -1609,13 +1554,13 @@ Insert @code{@@code@{@}} and put the cursor between the braces.@refill -@item C-c C-c d +@item C-c C-c d @itemx M-x texinfo-insert-@@dfn @findex texinfo-insert-@@dfn Insert @code{@@dfn@{@}} and put the cursor between the braces.@refill -@item C-c C-c e +@item C-c C-c e @itemx M-x texinfo-insert-@@end @findex texinfo-insert-@@end Insert @code{@@end} and attempt to insert the correct following word, @@ -1623,7 +1568,7 @@ nested lists correctly, but inserts the word appropriate to the immediately preceding list.)@refill -@item C-c C-c i +@item C-c C-c i @itemx M-x texinfo-insert-@@item @findex texinfo-insert-@@item Insert @code{@@item} and put the @@ -1635,11 +1580,11 @@ Insert @code{@@kbd@{@}} and put the cursor between the braces.@refill -@item C-c C-c n +@item C-c C-c n @itemx M-x texinfo-insert-@@node @findex texinfo-insert-@@node Insert @code{@@node} and a comment line -listing the sequence for the `Next', +listing the sequence for the `Next', `Previous', and `Up' nodes. Leave point after the @code{@@node}.@refill @@ -1658,7 +1603,7 @@ @item C-c C-c t @itemx M-x texinfo-insert-@@table @findex texinfo-insert-@@table -Insert @code{@@table} followed by a @key{SPC} +Insert @code{@@table} followed by a @key{SPC} and leave the cursor after the @key{SPC}.@refill @item C-c C-c v @@ -1673,7 +1618,7 @@ Insert @code{@@example} and put the cursor at the beginning of the next line.@refill -@c M-@{ was the binding for texinfo-insert-braces; +@c M-@{ was the binding for texinfo-insert-braces; @c in Emacs 19, backward-paragraph will take this binding. @item C-c C-c @{ @itemx M-x texinfo-insert-braces @@ -1694,12 +1639,12 @@ @emph{existing} word, position the cursor in front of the word and type @kbd{C-u 1 C-c C-c c}. This makes it easy to edit existing plain text. The value of the prefix argument tells Emacs how many words following -point to include between braces---@samp{1} for one word, @samp{2} for -two words, and so on. Use a negative argument to enclose the previous -word or words. If you do not specify a prefix argument, Emacs inserts -the @@-command string and positions the cursor between the braces. This -feature works only for those @@-commands that operate on a word or words -within one line, such as @code{@@kbd} and @code{@@var}.@refill +point to include between braces---1 for one word, 2 for two words, and +so on. Use a negative argument to enclose the previous word or words. +If you do not specify a prefix argument, Emacs inserts the @@-command +string and positions the cursor between the braces. This feature works +only for those @@-commands that operate on a word or words within one +line, such as @code{@@kbd} and @code{@@var}.@refill This set of insert commands was created after analyzing the frequency with which different @@-commands are used in the @cite{GNU Emacs @@ -1753,7 +1698,7 @@ in the Texinfo file.@refill @table @kbd -@item C-c C-s +@item C-c C-s @itemx M-x texinfo-show-structure @findex texinfo-show-structure Show the @code{@@chapter}, @code{@@section}, and such lines of a @@ -1786,7 +1731,7 @@ (@xref{Narrowing, , , emacs, The GNU Emacs Manual}, for more information about the narrowing commands.)@refill -@vindex page-delimiter +@vindex page-delimiter @cindex Page delimiter in Texinfo mode In addition to providing the @code{texinfo-show-structure} command, Texinfo mode sets the value of the page delimiter variable to match @@ -1803,7 +1748,7 @@ @cindex Updating nodes and menus @cindex Create nodes, menus automatically @cindex Insert nodes, menus automatically -@cindex Automatically insert nodes, menus +@cindex Automatically insert nodes, menus Texinfo mode provides commands for automatically creating or updating menus and node pointers. The commands are called ``update'' commands @@ -1955,7 +1900,7 @@ @itemx M-x texinfo-all-menus-update @findex texinfo-all-menus-update Create or update all the menus in the buffer. With an argument -(@kbd{C-u} as prefix argument, if interactive), first insert +(@kbd{C-u} as prefix argument, if interactive), first insert or update all the node pointers before working on the menus.@refill @@ -1969,7 +1914,7 @@ @example C-u C-c C-u C-a -@exdent or +@exdent or C-u M-x texinfo-all-menus-update @end example @@ -1999,7 +1944,7 @@ @cindex Requirements for updating commands To use the updating commands, you must organize the Texinfo file -hierarchically with chapters, sections, subsections, and the like. +hierarchically with chapters, sections, subsections, and the like. When you construct the hierarchy of the manual, do not `jump down' more than one level at a time: you can follow the `Top' node with a chapter, but not with a section; you can follow a chapter with a @@ -2124,7 +2069,7 @@ nodes' hierarchical level. This means that the `Next' node of a subsection may well be the next chapter. Sequentially ordered nodes are useful for novels and other documents that you read through -sequentially. (However, in Info, the @kbd{g *} command lets +sequentially. (However, in Info, the @code{g* @key{RET}} command lets you look through the file sequentially, so sequentially ordered nodes are not strictly necessary.) With an argument (prefix argument, if interactive), the @code{texinfo-sequential-node-update} command @@ -2185,8 +2130,10 @@ M-x makeinfo-buffer @end example -For @TeX{} or the Info formatting commands to work, the file @emph{must} -include a line that has @code{@@setfilename} in its header.@refill +For the Info formatting commands to work, the file @emph{must} include +a line that has @code{@@setfilename} in its header.@refill + +Not all systems support the @code{makeinfo}-based formatting commands.@refill @xref{Create an Info File}, for details about Info formatting.@refill @@ -2200,7 +2147,7 @@ @cindex Part of file formatting and printing Typesetting and printing a Texinfo file is a multi-step process in which -you first create a file for printing (called a DVI file), and then +you first create a file for printing (called a @sc{dvi} file), and then print the file. Optionally, you may also create indices. To do this, you must run the @code{texindex} command after first running the @code{tex} typesetting command; and then you must run the @code{tex} @@ -2235,7 +2182,7 @@ a second time after sorting the raw index files with the @code{texindex} command. (Usually, you do not format an index when you format a region, only when you format a buffer. Now that the @code{texi2dvi} command -exists, there is little or no need for this command.)@refill +exists, there is no little need for this command.)@refill @item C-c C-t C-p @itemx M-x texinfo-tex-print @@ -2260,7 +2207,7 @@ In Texinfo mode, each set of commands has default keybindings that begin with the same keys. All the commands that are custom-created -for Texinfo mode begin with @kbd{C-c}. The keys are somewhat +for Texinfo mode begin with @kbd{C-c}. The keys are somewhat mnemonic.@refill @subheading Insert Commands @@ -2341,7 +2288,7 @@ @group C-c C-u C-a @r{Make or update all} - @r{menus in a buffer.} + @r{menus in a buffer.} @end group @group @@ -2394,7 +2341,7 @@ C-c C-t C-r @r{Run @TeX{} on the region.} C-c C-t C-b @r{Run} @code{texi2dvi} @r{on the buffer.} C-c C-t C-i @r{Run} @code{texindex}. -C-c C-t C-p @r{Print the DVI file.} +C-c C-t C-p @r{Print the @sc{dvi} file.} C-c C-t C-q @r{Show the print queue.} C-c C-t C-d @r{Delete a job from the print queue.} C-c C-t C-k @r{Kill the current @TeX{} formatting job.} @@ -2464,18 +2411,18 @@ Generally, the beginning of a Texinfo file has four parts:@refill @enumerate -@item +@item The header, delimited by special comment lines, that includes the commands for naming the Texinfo file and telling @TeX{} what -definitions file to use when processing the Texinfo file.@refill - -@item +definitions' file to use when processing the Texinfo file.@refill + +@item A short statement of what the file is about, with a copyright notice and copying permissions. This is enclosed in @code{@@ifinfo} and @code{@@end ifinfo} commands so that the formatters place it only in the Info file.@refill -@item +@item A title page and copyright page, with a copyright notice and copying permissions. This is enclosed between @code{@@titlepage} and @code{@@end titlepage} commands. The title and copyright page appear @@ -2533,7 +2480,7 @@ @end group @group -@@c The following two commands +@@c The following two commands @@c start the copyright page. @@page @@vskip 0pt plus 1filll @@ -2545,12 +2492,12 @@ Permission is granted to @dots{} @@end titlepage -@@node Top, Overview, , (dir) +@@node Top, Overview, (dir), (dir) @@ifinfo -This document describes @dots{} - -This document applies to version @dots{} +This document describes @dots{} + +This document applies to version @dots{} of the program named @dots{} @@end ifinfo @@ -2590,7 +2537,7 @@ @example @group -\input texinfo @@c -*-texinfo-*- +\input texinfo @@c -*-texinfo-*- @@setfilename sample.info @@settitle Sample Document @end group @@ -2601,7 +2548,7 @@ @example @group -\input texinfo @@c -*-texinfo-*- +\input texinfo @@c -*-texinfo-*- @@c %**start of header @@setfilename sample.info @@settitle Sample Document @@ -2610,7 +2557,7 @@ @end example @menu -* First Line:: The first line of a Texinfo file. +* First Line:: The first line of a Texinfo file. * Start of Header:: Formatting a region requires this. * setfilename:: Tell Info the name of the Info file. * settitle:: Create a title for the printed work. @@ -2637,17 +2584,17 @@ This line serves two functions: @enumerate -@item -When the file is processed by @TeX{}, the @samp{\input texinfo} command +@item +When the file is processed by @TeX{}, the @code{\input texinfo} command tells @TeX{} to load the macros needed for processing a Texinfo file. These are in a file called @file{texinfo.tex}, which is usually located in the @file{/usr/lib/tex/macros} directory. @TeX{} uses the backslash, @samp{\}, to mark the beginning of a command, just as Texinfo uses -@samp{@@}. The @file{texinfo.tex} file causes the switch from @samp{\} +@code{@@}. The @file{texinfo.tex} file causes the switch from @samp{\} to @samp{@@}; before the switch occurs, @TeX{} requires @samp{\}, which is why it appears at the beginning of the file.@refill -@item +@item When the file is edited in GNU Emacs, the @samp{-*-texinfo-*-} mode specification tells Emacs to use Texinfo mode.@refill @end enumerate @@ -2681,47 +2628,38 @@ @cindex Info file requires @code{@@setfilename} @findex setfilename -In order to serve as the primary input file for either @code{makeinfo} -or @TeX{}, a Texinfo file must contain a line that looks like this: +In order to be made into an Info file, a Texinfo file must contain a line +that looks like this:@refill @example @@setfilename @var{info-file-name} @end example Write the @code{@@setfilename} command at the beginning of a line and -follow it on the same line by the Info file name. Do not write anything -else on the line; anything on the line after the command is considered -part of the file name, including what would otherwise be a -comment. +follow it on the same line by the Info file name. Do not write +anything else on the line; anything on the line after the command is +considered part of the file name, including a comment.@refill The @code{@@setfilename} line specifies the name of the Info file to be generated. This name should be different from the name of the Texinfo -file. There are two conventions for choosing the name: you can either -remove the @samp{.texi} extension from the input file name, or replace -it with the @samp{.info} extension. +file. The convention is to write a name with a @samp{.info} extension, +to produce an Info file name such as @file{texinfo.info}.@refill Some operating systems cannot handle long file names. You can run into a problem even when the file name you specify is itself short enough. This occurs because the Info formatters split a long Info file into -short indirect subfiles, and name them by appending @samp{-1}, -@samp{-2}, @dots{}, @samp{-10}, @samp{-11}, and so on, to the original -file name. (@xref{Tag and Split Files, , Tag Files and Split Files}.) -The subfile name @file{texinfo.info-10}, for example, is too long for -some systems; so the Info file name for this document is @file{texinfo} -rather than @file{texinfo.info}. - -@cindex Ignored before @code{@@setfilename} +short indirect subfiles, and name them by appending `-1', `-2', @dots{}, +`-10', `-11', and so on, to the original file name. (@xref{Tag and +Split Files, , Tag Files and Split Files}.) The subfile name +@file{texinfo.info-10}, for example, is too long for some systems; so +the Info file name for this document is actually @file{texinfo} rather than +@file{texinfo.info}.@refill + The Info formatting commands ignore everything written before the -@code{@@setfilename} line, which is why the very first line of -the file (the @code{\input} line) does not show up in the output. - -@pindex texinfo.cnf -The @code{@@setfilename} line produces no output when you typeset a -manual with @TeX{}, but it nevertheless is essential: it opens the -index, cross-reference, and other auxiliary files used by Texinfo, and -also reads @file{texinfo.cnf} if that file is present on your system -(@pxref{Preparing for TeX,, Preparing to Use @TeX{}}). - +@code{@@setfilename} line, which is why the very first line of +the file (the @code{\input} line) does not need to be commented out. +The @code{@@setfilename} line is ignored when you typeset a printed +manual.@refill @node settitle, setchapternewpage, setfilename, Header @comment node-name, next, previous, up @@ -2885,11 +2823,11 @@ commands do not change the existing indentation.@refill @item -If the value of @var{indent} is zero, the Info formatting commands delete +If the value of @var{indent} is 0, the Info formatting commands delete existing indentation.@refill @item -If the value of @var{indent} is greater than zero, the Info formatting +If the value of @var{indent} is greater than 0, the Info formatting commands indent the paragraph by that number of spaces.@refill @end itemize @@ -2908,7 +2846,7 @@ @node End of Header, , paragraphindent, Header @comment node-name, next, previous, up -@subsection End of Header +@subsection End of Header @cindex End of header line Follow the header lines with an @w{end-of-header} line. @@ -3008,8 +2946,8 @@ @code{@@end titlepage} on a line by itself.@refill The @code{@@end titlepage} command starts a new page and turns on page -numbering. (@xref{Headings, , Page Headings}, for details about how to -generate page headings.) All the material that you want to +numbering. (@xref{Headings, , Page Headings}, for details about how to +generate of page headings.) All the material that you want to appear on unnumbered pages should be put between the @code{@@titlepage} and @code{@@end titlepage} commands. By using the @code{@@page} command you can force a page break within the region @@ -3034,7 +2972,7 @@ should also contain this information; see @ref{makeinfo top, , @code{@@top}}.)@refill -Texinfo provides two main methods for creating a title page. One method +Texinfo provides two methods for creating a title page. One method uses the @code{@@titlefont}, @code{@@sp}, and @code{@@center} commands to generate a title page in which the words on the page are centered.@refill @@ -3047,13 +2985,6 @@ you want, and Texinfo does the formatting. You may use either method.@refill -@findex shorttitlepage -For extremely simple applications, Texinfo also provides a command -@code{@@shorttitlepage} which takes a single argument as the title. -The argument is typeset on a page by itself and followed by a blank -page. - - @node titlefont center sp, title subtitle author, titlepage, Titlepage & Copyright Page @comment node-name, next, previous, up @subsection @code{@@titlefont}, @code{@@center}, and @code{@@sp} @@ -3124,7 +3055,7 @@ You can use the @code{@@title}, @code{@@subtitle}, and @code{@@author} commands to create a title page in which the vertical and horizontal -spacing is done for you automatically. This contrasts with the method +spacing is done for you automatically. This contrasts with the method described in the previous section, in which the @code{@@sp} command is needed to adjust vertical spacing.@refill @@ -3270,7 +3201,7 @@ @subsection Heading Generation @findex end titlepage @cindex Headings, page, begin to appear -@cindex Titlepage end starts headings +@cindex Titlepage end starts headings @cindex End titlepage starts headings An @code{@@end titlepage} command on a line by itself not only marks @@ -3280,7 +3211,7 @@ To repeat what is said elsewhere, Texinfo has two standard page heading formats, one for documents which are printed on one side of each sheet of paper (single-sided printing), and the other for documents which are printed on both -sides of each sheet (double-sided printing). +sides of each sheet (double-sided printing). (@xref{setchapternewpage, ,@code{@@setchapternewpage}}.) You can specify these formats in different ways:@refill @@ -3322,7 +3253,7 @@ headings prior to defining your own. Write an @code{@@headings} command immediately after the @code{@@end titlepage} command.@refill -You can use @code{@@headings} as follows:@refill +There are four ways to use the @code{@@headings} command:@refill @table @code @item @@headings off @@ -3333,18 +3264,10 @@ @refill @item @@headings double +@itemx @@headings on Turn on page headings appropriate for double-sided printing. The two commands, @code{@@headings on} and @code{@@headings double}, are synonymous.@refill - -@item @@headings singleafter -@itemx @@headings doubleafter -Turn on @code{single} or @code{double} headings, respectively, after the -current page is output. - -@item @@headings on -Turn on page headings: @code{single} if @samp{@@setchapternewpage -on}, @code{double} otherwise. @end table For example, suppose you write @code{@@setchapternewpage off} before the @@ -3381,7 +3304,7 @@ The `Top' node is the node from which you enter an Info file.@refill A `Top' node should contain a brief description of the Info file and an -extensive, master menu for the whole Info file. +extensive, master menu for the whole Info file. This helps the reader understand what the Info file is about. Also, you should write the version number of the program to which the Info file applies; or, at least, the edition number.@refill @@ -3419,7 +3342,7 @@ @@end titlepage @@ifinfo -@@node Top, Copying, , (dir) +@@node Top, Copying, (dir), (dir) @@top Texinfo Texinfo is a documentation system@dots{} @@ -3433,7 +3356,7 @@ @group @@menu -* Copying:: Texinfo is freely +* Copying:: Texinfo is freely redistributable. * Overview:: What is Texinfo? @dots{} @@ -3474,9 +3397,7 @@ through an intermediary menu, an inquirer can go directly to a particular node when searching for specific information. These menu items are not required; add them if you think they are a -convenience. If you do use them, put @code{@@detailmenu} before the -first one, and @code{@@end detailmenu} after the last; otherwise, -@code{makeinfo} will get confused. +convenience.@refill @end itemize Each section in the menu can be introduced by a descriptive line. So @@ -3490,7 +3411,7 @@ @example @group @@menu -* Copying:: Texinfo is freely +* Copying:: Texinfo is freely redistributable. * Overview:: What is Texinfo? * Texinfo Mode:: Special features in GNU Emacs. @@ -3498,19 +3419,18 @@ @dots{} @end group @group -* Command and Variable Index:: +* Command and Variable Index:: An entry for each @@-command. * Concept Index:: An entry for each concept. @end group @group -@@detailmenu --- The Detailed Node Listing --- Overview of Texinfo * Info Files:: What is an Info file? -* Printed Manuals:: Characteristics of +* Printed Manuals:: Characteristics of a printed manual. @dots{} @dots{} @@ -3519,11 +3439,10 @@ @group Using Texinfo Mode -* Info on a Region:: Formatting part of a file +* Info on a Region:: Formatting part of a file for Info. @dots{} @dots{} -@@end detailmenu @@end menu @end group @end example @@ -3585,7 +3504,7 @@ @end example @menu -* Printing Indices & Menus:: How to print an index in hardcopy and +* Printing Indices & Menus:: How to print an index in hardcopy and generate index menus in Info. * Contents:: How to create a table of contents. * File End:: How to mark the end of a file. @@ -3681,21 +3600,17 @@ since that makes it easiest to find.)@refill @ignore -@c TeX can do sorting, just not conveniently enough to handle sorting -@c Texinfo indexes. --karl, 5may97. In @TeX{}, the @code{@@printindex} command needs a sorted index file to work from. @TeX{} does not know how to do sorting; this is a deficiency. @TeX{} writes output files of raw index data; use the @code{texindex} program to convert these files to sorted index files. (@xref{Format/Print Hardcopy}, for more information.)@refill @end ignore - - -@node Contents, File End, Printing Indices & Menus, Ending a File +@node Contents, File End, Printing Indices & Menus, Ending a File @comment node-name, next, previous, up @section Generating a Table of Contents @cindex Table of contents -@cindex Contents, Table of +@cindex Contents, Table of @findex contents @findex summarycontents @findex shortcontents @@ -3838,7 +3753,7 @@ Chapter 1 Chapter 2 Chapter 3 | | | -------- -------- -------- - | | | | | | + | | | | | | Section Section Section Section Section Section 1.1 1.2 2.1 2.2 3.1 3.2 @@ -3861,7 +3776,7 @@ @node Structuring Command Types, makeinfo top, Tree Structuring, Structuring @comment node-name, next, previous, up -@section Types of Structuring Commands +@section Types of Structuring Command The chapter structuring commands fall into four groups or series, each of which contains structuring commands corresponding to the @@ -3959,7 +3874,7 @@ @r{No new pages} @r{Numbered} @r{Unnumbered} @r{Lettered and numbered} @r{Unnumbered} @r{In contents} @r{In contents} @r{In contents} @r{Not in contents} - + @@top @@majorheading @@chapter @@unnumbered @@appendix @@chapheading @@section @@unnumberedsec @@appendixsec @@heading @@ -3979,7 +3894,7 @@ @r{No new pages} @r{Numbered} @r{Unnumbered} @r{Lettered and numbered} @r{Unnumbered} @r{In contents} @r{In contents} @r{In contents} @r{Not in contents} - + @@top @@majorheading @@chapter @@unnumbered @@appendix @@chapheading @@section @@unnumberedsec @@appendixsec @@heading @@ -3996,7 +3911,7 @@ @r{No new pages} @r{Numbered} @r{Unnumbered} @r{Lettered and numbered} @r{Unnumbered} @r{In contents} @r{In contents} @r{In contents} @r{Not in contents} - + @@top @@majorheading @@chapter @@unnumbered @@appendix @@chapheading @@section @@unnumberedsec @@appendixsec @@heading @@ -4009,11 +3924,11 @@ @node makeinfo top, chapter, Structuring Command Types, Structuring @comment node-name, next, previous, up -@section @code{@@top} +@section @code{@@top} The @code{@@top} command is a special sectioning command that you use -only after an @samp{@@node Top} line at the beginning of a Texinfo file. -The @code{@@top} command tells the @code{makeinfo} formatter +only after an @code{@@node Top} line at the beginning of a Texinfo file. +The @code{@@top} command tells the @code{makeinfo} formatter which node is the `Top' node. It has the same typesetting effect as @code{@@unnumbered} (@pxref{unnumbered & appendix, , @code{@@unnumbered}, @code{@@appendix}}). @@ -4049,13 +3964,6 @@ ******************* @end example -@findex centerchap -Texinfo also provides a command @code{@@centerchap}, which is analogous -to @code{@@unnumbered}, but centers its argument in the printed output. -This kind of stylistic choice is not usually offered by Texinfo. -@c but the Hacker's Dictionary wanted it ... - - @node unnumbered & appendix, majorheading & chapheading, chapter, Structuring @comment node-name, next, previous, up @section @code{@@unnumbered}, @code{@@appendix} @@ -4077,7 +3985,6 @@ line and follow it on the same line by the title, as you would if you were creating a chapter.@refill - @node majorheading & chapheading, section, unnumbered & appendix, Structuring @section @code{@@majorheading}, @code{@@chapheading} @findex majorheading @@ -4200,8 +4107,8 @@ @node unnumberedsubsec appendixsubsec subheading, subsubsection, subsection, Structuring @comment node-name, next, previous, up -@section The @code{@@subsection}-like Commands -@cindex Subsection-like commands +@section The @code{@@subsection}-like Commands +@cindex Subsection-like commands @findex unnumberedsubsec @findex appendixsubsec @findex subheading @@ -4224,7 +4131,7 @@ @node subsubsection, Raise/lower sections, unnumberedsubsec appendixsubsec subheading, Structuring @comment node-name, next, previous, up @section The `subsub' Commands -@cindex Subsub commands +@cindex Subsub commands @findex subsubsection @findex unnumberedsubsubsec @findex appendixsubsubsec @@ -4259,7 +4166,7 @@ headings.@refill @end table -In Info, `subsub' titles are underlined with periods. +In Info, `subsub' titles are underlined with periods. For example,@refill @example @@ -4279,10 +4186,10 @@ @node Raise/lower sections, , subsubsection, Structuring @comment node-name, next, previous, up @section @code{@@raisesections} and @code{@@lowersections} -@findex raisesections -@findex lowersections +@findex @@raisesections +@findex @@lowersections @cindex Raising and lowering sections -@cindex Sections, raising and lowering +@cindex Sections, raising and lowering The @code{@@raisesections} and @code{@@lowersections} commands raise and lower the hierarchical level of chapters, sections, subsections and the @@ -4290,7 +4197,6 @@ subsections to sections, and so on. The @code{@@lowersections} command changes chapters to sections, sections to subsections, and so on. -@cindex Include files, and section levels An @code{@@lowersections} command is useful if you wish to include text that is written as an outer or standalone Texinfo file in another Texinfo file as an inner, included file. If you write the command at @@ -4335,16 +4241,7 @@ line of its own. An @code{@@lowersections} command cancels an @code{@@raisesections} -command, and vice versa. Typically, the commands are used like this: - -@example -@@lowersections -@@include somefile.texi -@@raisesections -@end example - -Without the @code{@@raisesections}, all the subsequent sections in your -document will be lowered. +command, and vice versa. Repeated use of the commands continue to raise or lower the hierarchical level a step at a time. @@ -4367,7 +4264,7 @@ books.@refill @menu -* Two Paths:: Different commands to structure +* Two Paths:: Different commands to structure Info output and printed output. * Node Menu Illustration:: A diagram, and sample nodes and menus. * node:: How to write a node, in detail. @@ -4429,7 +4326,7 @@ Chapter 1 Chapter 2 Chapter 3 | | | -------- -------- -------- - | | | | | | + | | | | | | Section Section Section Section Section Section 1.1 1.2 2.1 2.2 3.1 3.2 @@ -4471,7 +4368,7 @@ @group @@menu * Sect. 2.1:: Description of this section. - * Sect. 2.2:: + * Sect. 2.2:: @@end menu @end group @end example @@ -4544,7 +4441,7 @@ Usually, you write one of the chapter-structuring command lines immediately after an @code{@@node} line---for example, an @code{@@section} or @code{@@subsection} line. (@xref{Structuring -Command Types, , Types of Structuring Commands}.)@refill +Command Types, , Types of Structuring Command}.)@refill @quotation @strong{Please note:} The GNU Emacs Texinfo mode updating commands work @@ -4565,7 +4462,7 @@ * Node Line Tips:: Keep names short. * Node Line Requirements:: Keep names unique, without @@-commands. * First Node:: How to write a `Top' node. -* makeinfo top command:: How to use the @code{@@top} command. +* makeinfo top command:: How to use the @code{@@top} command. * Top Node Summary:: Write a brief description for readers. @end menu @@ -4631,8 +4528,8 @@ If you wish, you can ignore @code{@@node} lines altogether in your first draft and then use the @code{texinfo-insert-node-lines} command to -create @code{@@node} lines for you. However, we do not -recommend this practice. It is better to name the node itself +create @code{@@node} lines for you. However, we do not +recommend this practice. It is better to name the node itself at the same time that you write a segment so you can easily make cross references. A large number of cross references are an especially important feature of a good Info @@ -4717,16 +4614,17 @@ @end smallexample @cindex Comma in nodename +@cindex Colon in nodename @cindex Apostrophe in nodename @item -You cannot use commas or apostrophes within a node name; these +You cannot use commas, colons, or apostrophes within a node name; these confuse @TeX{} or the Info formatters.@refill @need 700 For example, the following is a section title: @smallexample -@@code@{@@@@unnumberedsec@}, @@code@{@@@@appendixsec@}, @@code@{@@@@heading@} +@@code@{@@@@unnumberedsec@}, @@code@{@@@@appendixsec@}, @@code@{@@@@heading@} @end smallexample @noindent @@ -4741,47 +4639,37 @@ Case is significant. @end itemize - @node First Node, makeinfo top command, Node Line Requirements, node @comment node-name, next, previous, up -@subsection The First Node -@cindex Top node is first +@subsection The First Node +@cindex @samp{@r{Top}} node is first @cindex First node -The first node of a Texinfo file is the @dfn{Top} node, except in an -included file (@pxref{Include Files}). The Top node contains the main -or master menu for the document, and a short summary of the document -(@pxref{Top Node Summary}). - -@cindex Up node of Top node -@cindex (dir) as Up node of Top node -The Top node (which must be named @samp{top} or @samp{Top}) should have -as its `Up' node the name of a node in another file, where there is a -menu that leads to this file. Specify the file name in parentheses. If -the file is to be installed directly in the Info directory file, use -@samp{(dir)} as the parent of the Top node; this is short for -@samp{(dir)top}, and specifies the Top node in the @file{dir} file, -which contains the main menu for the Info system as a whole. For -example, the @code{@@node Top} line of this manual looks like this: - -@example -@@node Top, Copying, , (dir) -@end example - -@noindent -(You can use the Texinfo updating commands or the @code{makeinfo} -utility to insert these pointers automatically.) - -@cindex Previous node of Top node -Do not define the `Previous' node of the Top node to be @samp{(dir)}, as -it causes confusing behavior for users: if you are in the Top node and -hits @key{DEL} to go backwards, you wind up in the middle of the -some other entry in the @file{dir} file, which has nothing to do with -what you were reading. +The first node of a Texinfo file is the `Top' node, except in an +included file (@pxref{Include Files}). + +The `Top' node (which must be named @samp{top} or @samp{Top}) should +have as its `Up' and `Previous' nodes the name of a node in another +file, where there is a menu that leads to this file. Specify the file +name in parentheses. If the file is to be installed directly in the +Info directory file, use @samp{(dir)} as the parent of the `Top' node; +this is short for @samp{(dir)top}, and specifies the `Top' node in the +@file{dir} file, which contains the main menu for Info. For example, +the @code{@@node Top} line of this manual looks like this:@refill + +@example +@@node Top, Overview, (dir), (dir) +@end example + +@noindent +(You may use the Texinfo updating commands or the @code{makeinfo} +utility to insert these `Next' and @samp{(dir)} pointers +automatically.)@refill @xref{Install an Info File}, for more information about installing -an Info file in the @file{info} directory. - +an Info file in the @file{info} directory.@refill + +The `Top' node contains the main or master menu for the document. @node makeinfo top command, Top Node Summary, First Node, node @comment node-name, next, previous, up @@ -4809,7 +4697,6 @@ @code{@@unnumbered} when you use the Texinfo updating commands to create or update pointers and menus.@refill - @node Top Node Summary, , makeinfo top command, node @subsection The `Top' Node Summary @cindex @samp{@r{Top}} node summary @@ -4947,11 +4834,11 @@ * Menu Parts:: A menu entry has three parts. * Less Cluttered Menu Entry:: Two part menu entry. * Menu Example:: Two and three part entries. -* Other Info Files:: How to refer to a different +* Other Info Files:: How to refer to a different Info file. @@end menu -@@node Menu Location, Writing a Menu, , Menus +@@node Menu Location, Writing a Menu, , Menus @@ifinfo @@heading Menus Need Short Nodes @@end ifinfo @@ -4980,7 +4867,7 @@ Larger Units of Text * Files:: All about handling files. -* Multiples: Buffers. Multiple buffers; editing +* Multiples: Buffers. Multiple buffers; editing several files at once. @@end menu @end group @@ -5001,17 +4888,18 @@ @cindex Menu parts @cindex @code{@@menu} parts -A menu entry has three parts, only the second of which is required: +A menu entry has three parts, only the second of which is +required:@refill @enumerate @item -The menu entry name (optional). +The menu entry name. @item The name of the node (required). @item -A description of the item (optional). +A description of the item. @end enumerate The template for a menu entry looks like this:@refill @@ -5027,14 +4915,12 @@ command. The menu entry name is what the user types after the @kbd{m} command.@refill -The third part of a menu entry is a descriptive phrase or sentence. -Menu entry names and node names are often short; the description -explains to the reader what the node is about. A useful description -complements the node name rather than repeats it. The description, -which is optional, can spread over two or more lines; if it does, some -authors prefer to indent the second line while others prefer to align it -with the first (and all others). It's up to you. - +The third part of a menu entry is a descriptive phrase or +sentence. Menu entry names and node names are often short; the +description explains to the reader what the node is about. The +description, which is optional, can spread over two or more lines. A +useful description complements the node name rather than repeats +it.@refill @node Less Cluttered Menu Entry, Menu Example, Menu Parts, Menus @comment node-name, next, previous, up @@ -5106,7 +4992,7 @@ Larger Units of Text * Files:: All about handling files. -* Multiples: Buffers. Multiple buffers; editing +* Multiples: Buffers. Multiple buffers; editing several files at once. @@end menu @end group @@ -5122,7 +5008,7 @@ Larger Units of Text * Files:: All about handling files. -* Multiples: Buffers. Multiple buffers; editing +* Multiples: Buffers. Multiple buffers; editing several files at once. @end group @end example @@ -5171,9 +5057,9 @@ @example @group @@menu -* Outlining: (emacs)Outline Mode. The major mode for +* Outlining: (emacs)Outline Mode. The major mode for editing outlines. -* Rebinding: (emacs)Rebinding. How to redefine the +* Rebinding: (emacs)Rebinding. How to redefine the meaning of a key. @@end menu @end group @@ -5192,7 +5078,7 @@ @example @group * Info: (info). Documentation browsing system. -* Emacs: (emacs). The extensible, self-documenting +* Emacs: (emacs). The extensible, self-documenting text editor. @end group @end example @@ -5226,7 +5112,6 @@ * ref:: A reference for the last part of a sentence. * pxref:: How to write a parenthetical cross reference. * inforef:: How to refer to an Info-only file. -* uref:: How to refer to a uniform resource locator. @end menu @node References, Cross Reference Commands, Cross References, Cross References @@ -5260,7 +5145,7 @@ reference locations. This is evident in Info, in which a cross reference takes you to the specified node. @TeX{} also uses nodes to define cross reference locations, but the action is less obvious. When -@TeX{} generates a DVI file, it records nodes' page numbers and +@TeX{} generates a @sc{dvi} file, it records nodes' page numbers and uses the page numbers in making references. Thus, if you are writing a manual that will only be printed, and will not be used on-line, you must nonetheless write @code{@@node} lines to name the places to which @@ -5338,7 +5223,7 @@ @example @group -@@xref@{Node name, Cross Reference Name, Particular Topic, +@@xref@{Node name, Cross Reference Name, Particular Topic, info-file-name, A Printed Manual@}, for details. @end group @end example @@ -5372,8 +5257,8 @@ @item 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.@refill +from the node name. If you include this argument, it argument becomes +the first part of the cross reference. It is usually omitted.@refill @item A topic description or section name. Often, this is the title of the @@ -5382,9 +5267,7 @@ @item The name of the Info file in which the reference is located, if it is -different from the current file. You need not include any @samp{.info} -suffix on the file name, since Info readers try appending it -automatically. +different from the current file.@refill @item The name of a printed manual from a different Texinfo file.@refill @@ -5581,7 +5464,7 @@ @end example @noindent -and +and @quotation See Section 5.2 [Electrical Effects], page 57. @@ -5604,7 +5487,7 @@ @end example @noindent -and +and @quotation See Section 5.2 [Electrical Effects], page 57, for more info. @@ -5701,13 +5584,13 @@ same, and with the first and third arguments if the node name and title are different.@refill -Here are several examples from @cite{The GNU Awk User's Guide}:@refill +Here are several examples from @cite{The GAWK Manual}:@refill @smallexample @@xref@{Sample Program@}. @@xref@{Glossary@}. @@xref@{Case-sensitivity, ,Case-sensitivity in Matching@}. -@@xref@{Close Output, , Closing Output Files and Pipes@}, +@@xref@{Close Output, , Closing Output Files and Pipes@}, for more information. @@xref@{Regexp, , Regular Expressions as Patterns@}. @end smallexample @@ -5739,7 +5622,7 @@ For example, @example -@@xref@{Electrical Effects, Lightning, Thunder and Lightning, +@@xref@{Electrical Effects, Lightning, Thunder and Lightning, weather, An Introduction to Meteorology@}, for details. @end example @@ -5798,7 +5681,7 @@ For example, @example -@@xref@{Electrical Effects, , Thunder and Lightning, +@@xref@{Electrical Effects, , Thunder and Lightning, weather, An Introduction to Meteorology@}, for details. @end example @@ -6038,7 +5921,8 @@ breaks up the flow of text.@refill @end quotation -@node inforef, uref, pxref, Cross References +@node inforef, , pxref, Cross References +@comment node-name, next, previous, up @section @code{@@inforef} @cindex Cross references using @code{@@inforef} @cindex References using @code{@@inforef} @@ -6135,51 +6019,6 @@ refer to printed works for which no Info form exists. @xref{cite, , @code{@@cite}}.@refill - -@node uref, , inforef, Cross References -@section @code{@@uref@{@var{url}[, @var{displayed-text}]@}} -@findex uref -@cindex Uniform resource locator, referring to -@cindex URL, referring to - -@code{@@uref} produces a reference to a uniform resource locator (URL). -It takes one mandatory argument, the URL, and one optional argument, the -text to display (the default is the URL itself). In HTML output, -@code{@@uref} produces a link you can follow. For example: - -@example -The official GNU ftp site is -@@uref@{ftp://ftp.gnu.ai.mit.edu/pub/gnu@} -@end example - -@noindent produces (in text): -@display -The official GNU ftp site is -@uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu} -@end display - -@noindent whereas -@example -The official -@@uref@{ftp://ftp.gnu.ai.mit.edu/pub/gnu, - GNU ftp site@} holds programs and texts. -@end example - -@noindent produces (in text): -@display -The official @uref{ftp://ftp.gnu.ai.mit.edu/pub/gnu, GNU ftp site} holds -programs and texts. -@end display - -@noindent and (in HTML): -@example -The official <A HREF="ftp://ftp.gnu.ai.mit.edu/pub/gnu">GNU ftp -site</A> holds programs and texts. -@end example - -To merely indicate a URL, use @code{@@url} (@pxref{url, @code{@@url}}). - - @node Marking Text, Quotations and Examples, Cross References, Top @comment node-name, next, previous, up @chapter Marking Words and Phrases @@ -6214,7 +6053,7 @@ an @emph{intentional} formatting language rather than a @emph{typesetting} formatting language.)@refill -For example, in a printed manual, +For example, in a printed manual, code is usually illustrated in a typewriter font; @code{@@code} tells @TeX{} to typeset this text in this font. But it would be easy to change the way @TeX{} highlights code to use another @@ -6234,8 +6073,6 @@ * file:: How to indicate the name of a file. * dfn:: How to specify a definition. * cite:: How to refer to a book that is not in Info. -* url:: How to indicate a world wide web reference. -* email:: How to indicate an electronic mail address. @end menu @node Useful Highlighting, code, Indicating, Indicating @@ -6269,15 +6106,9 @@ @item @@var@{@var{metasyntactic-variable}@} Indicate a metasyntactic variable.@refill -@item @@url@{@var{uniform-resource-locator}@} -Indicate a uniform resource locator for the World Wide Web. - @item @@file@{@var{file-name}@} Indicate the name of a file.@refill -@item @@email@{@var{email-address}[, @var{displayed-text}]@} -Indicate an electronic mail address. - @item @@dfn@{@var{term}@} Indicate the introductory or defining use of a term.@refill @@ -6310,7 +6141,7 @@ and other variables.@refill Use @code{@@code} for command names in command languages that -resemble programming languages, such as Texinfo or the shell. +resemble programming languages, such as Texinfo or the shell. For example, @code{@@code} and @code{@@samp} are produced by writing @samp{@@code@{@@@@code@}} and @samp{@@code@{@@@@samp@}} in the Texinfo source, respectively.@refill @@ -6374,11 +6205,10 @@ @end example @end iftex - @node kbd, key, code, Indicating +@comment node-name, next, previous, up @subsection @code{@@kbd}@{@var{keyboard-characters}@} @findex kbd -@cindex keyboard input Use the @code{@@kbd} command for characters of input to be typed by users. For example, to refer to the characters @kbd{M-a}, @@ -6395,31 +6225,8 @@ @@kbd@{M-x shell@} @end example -@cindex user input -@cindex slanted typewriter font, for @code{@@kbd} The @code{@@kbd} command has the same effect as @code{@@code} in Info, -but by default produces a different font (slanted typewriter instead of -normal typewriter) in the printed manual, so users can distinguish the -characters they are supposed to type from those the computer outputs. - -@findex kbdinputstyle -Since the usage of @code{@@kbd} varies from manual to manual, you can -control the font switching with the @code{@@kbdinputstyle} command. -This command has no effect on Info output. Write this command at the -beginning of a line with a single word as an argument, one of the -following: -@vindex distinct@r{, arg to @@kbdinputstyle} -@vindex example@r{, arg to @@kbdinputstyle} -@vindex code@r{, arg to @@kbdinputstyle} -@table @samp -@item code -Always use the same font for @code{@@kbd} as @code{@@code}. -@item example -Use the distinguishing font for @code{@@kbd} only in @code{@@example} -and similar environments. -@item example -(the default) Always use the distinguishing font for @code{@@kbd}. -@end table +but may produce a different font in a printed manual.@refill You can embed another @@-command inside the braces of an @code{@@kbd} command. Here, for example, is the way to describe a command that @@ -6427,7 +6234,7 @@ press the @key{RET} key'':@refill @example -@@kbd@{r @@key@{RET@}@} +@@kbd@{r @@key@{RET@}@} @end example @noindent @@ -6437,7 +6244,7 @@ you type; for example:@refill @example -To give the @@code@{logout@} command, +To give the @@code@{logout@} command, type the characters @@kbd@{l o g o u t @@key@{RET@}@}. @end example @@ -6445,7 +6252,7 @@ This produces: @quotation -To give the @code{logout} command, +To give the @code{logout} command, type the characters @kbd{l o g o u t @key{RET}}. @end quotation @@ -6453,7 +6260,6 @@ really want to mention a space character as one of the characters of input, write @kbd{@@key@{SPC@}} for it.)@refill - @node key, samp, kbd, Indicating @comment node-name, next, previous, up @subsection @code{@@key}@{@var{key-name}@} @@ -6477,7 +6283,10 @@ @@kbd@{C-x @@key@{ESC@}@} @end example -Here is a list of the recommended names for keys: +@c bob: this next sentence looks weird, having a semi-colon followed by +@c a colon that ends the "sentence".. --mew +Here is a list of the recommended names for keys; they are all in +upper case:@refill @cindex Recommended names for keys @cindex Keys, recommended names @cindex Names recommended for keys @@ -6490,8 +6299,7 @@ @item RET Return @item LFD -Linefeed (however, since most keyboards nowadays do not have a Linefeed key, -it might be better to call this character @kbd{C-j}. +Linefeed @item TAB Tab @item BS @@ -6500,30 +6308,29 @@ Escape @item DEL Delete -@item SHIFT +@item SFT Shift -@item CTRL +@item CTL Control @item META Meta @end table @end quotation +There are subtleties to handling words like `meta' or `ctl' that are +names of shift keys. When mentioning a character in which the shift +key is used, such as @kbd{Meta-a}, use the @code{@@kbd} command alone; +do not use the @code{@@key} command; but when you are referring to the +shift key in isolation, use the @code{@@key} command. For example, +write @samp{@@kbd@{Meta-a@}} to produce @kbd{Meta-a} and +@samp{@@key@{META@}} to produce @key{META}. This is because +@kbd{Meta-a} refers to keys that you press on a keyboard, but +@key{META} refers to a key without implying that you press it. In +short, use @code{@@kbd} for what you do, and use @code{@@key} for what +you talk about: ``Press @code{@@kbd@{M-a@}} to move point to the +beginning of the sentence. The @code{@@key@{META@}} key is often in the +lower left of the keyboard.''@refill @cindex META key -There are subtleties to handling words like `meta' or `ctrl' that are -names of modifier keys. When mentioning a character in which the -modifier key is used, such as @kbd{Meta-a}, use the @code{@@kbd} command -alone; do not use the @code{@@key} command; but when you are referring -to the modifier key in isolation, use the @code{@@key} command. For -example, write @samp{@@kbd@{Meta-a@}} to produce @kbd{Meta-a} and -@samp{@@key@{META@}} to produce @key{META}. - -@c I don't think this is a good explanation. -@c I think it will puzzle readers more than it clarifies matters. -- rms. -@c In other words, use @code{@@kbd} for what you do, and use @code{@@key} -@c for what you talk about: ``Press @code{@@kbd@{M-a@}} to move point to -@c the beginning of the sentence. The @code{@@key@{META@}} key is often in -@c the lower left of the keyboard.''@refill @node samp, var, key, Indicating @comment node-name, next, previous, up @@ -6537,7 +6344,7 @@ addition, it is printed in a fixed-width font.@refill @example -To match @@samp@{foo@} at the end of the line, +To match @@samp@{foo@} at the end of the line, use the regexp @@samp@{foo$@}. @end example @@ -6550,11 +6357,10 @@ @end quotation Any time you are referring to single characters, you should use -@code{@@samp} unless @code{@@kbd} or @code{@@key} is more appropriate. -Use @code{@@samp} for the names of command-line options (except in an -@code{@@table}, where @code{@@code} seems to read more easily). Also, -you may use @code{@@samp} for entire statements in C and for entire -shell commands---in this case, @code{@@samp} often looks better than +@code{@@samp} unless @code{@@kbd} is more appropriate. Use +@code{@@samp} for the names of command-line options. Also, you may use +@code{@@samp} for entire statements in C and for entire shell +commands---in this case, @code{@@samp} often looks better than @code{@@code}. Basically, @code{@@samp} is a catchall for whatever is not covered by @code{@@code}, @code{@@kbd}, or @code{@@key}.@refill @@ -6566,8 +6372,8 @@ @example @group -In English, the vowels are @@samp@{a@}, @@samp@{e@}, -@@samp@{i@}, @@samp@{o@}, @@samp@{u@}, and sometimes +In English, the vowels are @@samp@{a@}, @@samp@{e@}, +@@samp@{i@}, @@samp@{o@}, @@samp@{u@}, and sometimes @@samp@{y@}. @end group @end example @@ -6577,7 +6383,7 @@ @quotation In English, the vowels are @samp{a}, @samp{e}, -@samp{i}, @samp{o}, @samp{u}, and sometimes +@samp{i}, @samp{o}, @samp{u}, and sometimes @samp{y}. @end quotation @@ -6594,18 +6400,18 @@ Do not use @code{@@var} for the names of particular variables in programming languages. These are specific names from a program, so -@code{@@code} is correct for them. For example, the Emacs Lisp variable +@code{@@code} is correct for them. For example, the Lisp variable @code{texinfo-tex-command} is not a metasyntactic variable; it is properly formatted using @code{@@code}.@refill The effect of @code{@@var} in the Info file is to change the case of -the argument to all upper case; in the printed manual, to italicize it. +the argument to all upper case; in the printed manual, to italicize it. @need 700 For example, @example -To delete file @@var@{filename@}, +To delete file @@var@{filename@}, type @@code@{rm @@var@{filename@}@}. @end example @@ -6670,7 +6476,7 @@ For example,@refill @example -The @@file@{.el@} files are in +The @@file@{.el@} files are in the @@file@{/usr/local/emacs/lisp@} directory. @end example @@ -6678,7 +6484,7 @@ produces @quotation -The @file{.el} files are in +The @file{.el} files are in the @file{/usr/local/emacs/lisp} directory. @end quotation @@ -6711,7 +6517,7 @@ to say explicitly that it is a definition, but it should contain the information of a definition---it should make the meaning clear. -@node cite, url, dfn, Indicating +@node cite, , dfn, Indicating @comment node-name, next, previous, up @subsection @code{@@cite}@{@var{reference}@} @findex cite @@ -6723,16 +6529,16 @@ (If a book is written in Texinfo, it is better to use a cross reference command since a reader can easily follow such a reference in Info. @xref{xref, , @code{@@xref}}.)@refill - @ignore -@c node ctrl, , cite, Indicating + +@c node ctrl, , cite, Indicating @comment node-name, next, previous, up @c subsection @code{@@ctrl}@{@var{ctrl-char}@} @findex ctrl The @code{@@ctrl} command is seldom used. It describes an @sc{ascii} control character by inserting the actual character into the Info -file. +file. Usually, in Texinfo, you talk what you type as keyboard entry by describing it with @code{@@kbd}: thus, @samp{@@kbd@{C-a@}} for @@ -6773,52 +6579,6 @@ @var{ch}.@refill @end ignore - -@node url, email, cite, Indicating -@subsection @code{@@url}@{@var{uniform-resource-locator}@} -@findex url -@cindex Uniform resource locator, indicating -@cindex URL, indicating - -Use the @code{@@url} to indicate a uniform resource locator on the World -Wide Web. This is analogous to @code{@@file}, @code{@@var}, etc., and -is purely for markup purposes. It does not produce a link you can -follow in HTML output (the @code{@@uref} command does, @pxref{uref,, -@code{@@uref}}). It is useful for example URL's which do not actually -exist. For example: - -@c Two lines because one is too long for smallbook format. -@example -For example, the url might be -@@url@{http://host.domain.org/path@}. -@end example - - -@node email, , url, Indicating -@subsection @code{@@email}@{@var{email-address}[, @var{displayed-text}]@} -@findex email - -Use the @code{@@email} command to indicate an electronic mail address. -It takes one mandatory argument, the address, and one optional argument, the -text to display (the default is the address itself). - -@cindex mailto link -In Info and @TeX{}, the address is shown in angle brackets, preceded by -the text to display if any. In HTML output, @code{@@email} produces a -@samp{mailto} link that usually brings up a mail composition window. -For example: - -@example -Send bug reports to @@email@{bug-texinfo@@@@prep.ai.mit.edu@}. -Send suggestions to the @@email@{bug-texinfo@@@@prep.ai.mit.edu, same place@}. -@end example -@noindent produces -@example -Send bug reports to @email{bug-texinfo@@prep.ai.mit.edu}. -Send suggestions to the @email{bug-texinfo@@prep.ai.mit.edu, same place}. -@end example - - @node Emphasis, , Indicating, Marking Text @comment node-name, next, previous, up @section Emphasizing Text @@ -6858,7 +6618,7 @@ @example @group @@quotation -@@strong@{Caution:@} @@samp@{rm * .[^.]*@} removes @@emph@{all@} +@@strong@{Caution:@} @@code@{rm * .[^.]*@} removes @@emph@{all@} files in the directory. @@end quotation @end group @@ -6869,7 +6629,7 @@ produces the following in printed output: @quotation -@strong{Caution}: @code{rm * .[^.]*} removes @emph{all} +@strong{Caution}: @code{rm * .[^.]*} removes @emph{all} files in the directory. @end quotation @@ -6882,7 +6642,7 @@ @end ifinfo @example - *Caution*: `rm * .[^.]*' removes *all* + *Caution*: `rm * .[^.]*' removes *all* files in the directory. @end example @@ -7001,19 +6761,17 @@ @node Customized Highlighting, , Fonts, Emphasis @comment node-name, next, previous, up @subsection Customized Highlighting +@findex @@definfoenclose +@cindex `Enclosure' command for Info @cindex Highlighting, customized @cindex Customized highlighting -@c I think this whole section is obsolete with the advent of macros -@c --karl, 15sep96. You can use regular @TeX{} commands inside of @code{@@iftex} @dots{} @code{@@end iftex} to create your own customized highlighting commands for Texinfo. The easiest way to do this is to equate your customized commands with pre-existing commands, such as those for italics. Such new commands work only with @TeX{}.@refill -@findex definfoenclose -@cindex Enclosure command for Info You can use the @code{@@definfoenclose} command inside of @code{@@ifinfo} @dots{} @code{@@end ifinfo} to define commands for Info with the same names as new commands for @TeX{}. @@ -7043,7 +6801,7 @@ This defines @code{@@phoo} as a command that causes @TeX{} to typeset the argument to @code{@@phoo} in italics. @code{@@global@@let} tells @TeX{} to equate the next argument with the argument that follows the -equals sign. +equals sign. @need 1300 For Info, write the following to tell the Info formatters to enclose the @@ -7060,7 +6818,7 @@ @noindent Write the @code{@@definfoenclose} command on a line and follow it with three arguments separated by commas (commas are used as separators in an -@code{@@node} line in the same way).@refill +@code{@@node} line in the same way).@refill @itemize @bullet @item @@ -7071,7 +6829,7 @@ the second argument is the Info start delimiter string; and, @item -the third argument is the Info end delimiter string. +the third argument is the Info end delimiter string. @end itemize @noindent @@ -7096,7 +6854,7 @@ the other for Info. @need 1200 -Here is another example: +Here is another example: @example @group @@ -7132,7 +6890,7 @@ @findex end @menu -* Block Enclosing Commands:: Use different constructs for +* Block Enclosing Commands:: Use different constructs for different purposes. * quotation:: How to write a quotation. * example:: How to write an example in a fixed-width font. @@ -7162,7 +6920,7 @@ in a fixed-width font, and indented but not filled.@refill @item @@lisp -Illustrate Lisp code. The text is printed in a fixed-width font, +Illustrate Lisp code. The text is printed in a fixed-width font, and indented but not filled.@refill @item @@smallexample @@ -7186,7 +6944,7 @@ @end table The @code{@@exdent} command is used within the above constructs to -undo the indentation of a line. +undo the indentation of a line. The @code{@@flushleft} and @code{@@flushright} commands are used to line up the left or right margins of unfilled text.@refill @@ -7263,7 +7021,7 @@ @example @group This is an example of text written between an -@code{@@example} command +@code{@@example} command and an @code{@@end example} command. The text is indented but not filled. @end group @@ -7345,7 +7103,7 @@ This is an example @@end example -@@noindent +@@noindent This line is not indented. As you can see, the beginning of the line is fully flush left with the line that follows after it. (This whole example is between @@ -7397,12 +7155,12 @@ @code{@@lisp} command and an @code{@@end lisp} command. @end lisp -Use @code{@@lisp} instead of @code{@@example} to preserve information -regarding the nature of the example. This is useful, for example, if -you write a function that evaluates only and all the Lisp code in a -Texinfo file. Then you can use the Texinfo file as a Lisp -library.@footnote{It would be straightforward to extend Texinfo to work -in a similar fashion for C, Fortran, or other languages.}@refill +Use @code{@@lisp} instead of @code{@@example} so as to preserve +information regarding the nature of the example. This is useful, for +example, if you write a function that evaluates only and all the Lisp +code in a Texinfo file. Then you can use the Texinfo file as a Lisp +library.@footnote{It would be straightforward to extend Texinfo to +work in a similar fashion for C, @sc{fortran}, or other languages.}@refill Mark the end of @code{@@lisp} with @code{@@end lisp} on a line by itself.@refill @@ -7410,7 +7168,7 @@ @node smallexample & smalllisp, display, Lisp Example, Quotations and Examples @comment node-name, next, previous, up @section @code{@@smallexample} and @code{@@smalllisp} -@cindex Small book example +@cindex Small book example @cindex Example for a small book @cindex Lisp example for a small book @findex smallexample @@ -7450,12 +7208,12 @@ @tex % Remove extra vskip; this is a kludge to counter the effect of display \vskip-3\baselineskip -{\ninett +{\ninett \dots{} to make sure that you have the freedom to -distribute copies of free software (and charge for -this service if you wish), that you receive source -code or can get it if you want it, that you can -change the software or use pieces of it in new free +distribute copies of free software (and charge for +this service if you wish), that you receive source +code or can get it if you want it, that you can +change the software or use pieces of it in new free programs; and that you know you can do these things.} @end tex @end display @@ -7524,7 +7282,7 @@ @format This is an example of text written between an @code{@@format} command and an @code{@@end format} command. As you can see -from this example, +from this example, the @code{@@format} command does not fill the text. @end format @@ -7586,7 +7344,7 @@ @example @group @@flushleft -This text is +This text is written flushleft. @@end flushleft @end group @@ -7597,20 +7355,24 @@ @quotation @flushleft -This text is +This text is written flushleft. @end flushleft @end quotation -@code{@@flushright} produces the type of indentation often used in the -return address of letters. For example, +Flushright produces the type of indentation often used in the return +address of letters.@refill + +@need 1500 +@noindent +For example, @example @group @@flushright Here is an example of text written -flushright. The @@code@{@@flushright@} command +flushright. The @@code@{@@flushright@} command right justifies every line but leaves the left end ragged. @@end flushright @@ -7642,14 +7404,14 @@ no effect in the Info file.@refill @need 1500 -For example, +For example, @example @group @@example @@cartouche % pwd -/usr/local/share/emacs +/usr/local/lib/emacs/info @@end cartouche @@end example @end group @@ -7672,23 +7434,22 @@ @end example @end iftex - @node Lists and Tables, Indices, Quotations and Examples, Top -@chapter Lists and Tables +@comment node-name, next, previous, up +@chapter Making Lists and Tables @cindex Making lists and tables -@cindex Lists and tables, making -@cindex Tables and lists, making - -Texinfo has several ways of making lists and tables. Lists can be -bulleted or numbered; two-column tables can highlight the items in -the first column; multi-column tables are also supported. +@cindex Lists and tables, making them +@cindex Tables and lists, making them + +Texinfo has several ways of making lists and two-column tables. Lists can +be bulleted or numbered, while two-column tables can highlight the items in +the first column.@refill @menu * Introducing Lists:: Texinfo formats lists for you. * itemize:: How to construct a simple list. * enumerate:: How to construct a numbered list. * Two-column Tables:: How to construct a two-column table. -* Multi-column Tables:: How to construct generalized tables. @end menu @ifinfo @@ -7721,13 +7482,13 @@ Here is an itemized list of the different kinds of table and lists:@refill @itemize @bullet -@item +@item Itemized lists with and without bullets. -@item +@item Enumerated lists, using numbers or letters. -@item +@item Two-column tables with highlighting. @end itemize @@ -7736,13 +7497,13 @@ Here is an enumerated list with the same items:@refill @enumerate -@item +@item Itemized lists with and without bullets. -@item +@item Enumerated lists, using numbers or letters. -@item +@item Two-column tables with highlighting. @end enumerate @@ -7761,7 +7522,7 @@ @item @@table @itemx @@ftable @itemx @@vtable -Two-column tables with indexing. +Two-column tables with highlighting. @end table @node itemize, enumerate, Introducing Lists, Lists and Tables @@ -7771,7 +7532,7 @@ @findex itemize The @code{@@itemize} command produces sequences of indented -paragraphs, with a bullet or other mark inside the left margin +paragraphs, with a bullet or other mark inside the left margin at the beginning of each paragraph for which such a mark is desired.@refill Begin an itemized list by writing @code{@@itemize} at the beginning of @@ -7878,22 +7639,23 @@ @cindex Enumeration @findex enumerate -@code{@@enumerate} is like @code{@@itemize} (@pxref{itemize,, -@code{@@itemize}}), except that the labels on the items are -successive integers or letters instead of bullets. - -Write the @code{@@enumerate} command at the beginning of a line. The -command does not require an argument, but accepts either a number or a -letter as an option. Without an argument, @code{@@enumerate} starts the -list with the number @samp{1}. With a numeric argument, such as -@samp{3}, the command starts the list with that number. With an upper -or lower case letter, such as @samp{a} or @samp{A}, the command starts -the list with that letter.@refill +@code{@@enumerate} is like @code{@@itemize} except that the marks in +the left margin contain successive integers or letters. +(@xref{itemize, , @code{@@itemize}}.)@refill + +Write the @code{@@enumerate} command at the beginning of a line. +The command does not require an argument, but accepts either a number or +a letter as an option. +Without an argument, @code{@@enumerate} starts the list +with the number 1. With a numeric argument, such as 3, +the command starts the list with that number. +With an upper or lower case letter, such as @kbd{a} or @kbd{A}, +the command starts the list with that letter.@refill Write the text of the enumerated list in the same way you write an -itemized list: put @code{@@item} on a line of its own before the start -of each paragraph that you want enumerated. Do not write any other text -on the line beginning with @code{@@item}.@refill +itemized list: put @code{@@item} on a line of its own before the start of +each paragraph that you want enumerated. Do not write any other text on +the line beginning with @code{@@item}.@refill You should put a blank line between entries in the list. This generally makes it easier to read the Info file.@refill @@ -7959,50 +7721,52 @@ using @code{@@enumerate} with an argument of @kbd{a}.@refill @sp 1 @enumerate a -@item +@item @code{@@enumerate} Without an argument, produce a numbered list, starting with the number 1.@refill -@item +@item @code{@@enumerate @var{positive-integer}} With a (positive) numeric argument, start a numbered list with that number. You can use this to continue a list that you interrupted with other text.@refill -@item +@item @code{@@enumerate @var{upper-case-letter}} -With an upper case letter as argument, start a list +With an upper case letter as argument, start a list in which each item is marked by a letter, beginning with that upper case letter.@refill -@item +@item @code{@@enumerate @var{lower-case-letter}} -With a lower case letter as argument, start a list +With a lower case letter as argument, start a list in which each item is marked by a letter, beginning with that lower case letter.@refill @end enumerate You can also nest enumerated lists, as in an outline.@refill -@node Two-column Tables, Multi-column Tables, enumerate, Lists and Tables +@node Two-column Tables, , enumerate, Lists and Tables +@comment node-name, next, previous, up @section Making a Two-column Table @cindex Tables, making two-column @findex table -@code{@@table} is similar to @code{@@itemize} (@pxref{itemize,, -@code{@@itemize}}), but allows you to specify a name or heading line for -each item. The @code{@@table} command is used to produce two-column -tables, and is especially useful for glossaries, explanatory -exhibits, and command-line option summaries. +@code{@@table} is similar to @code{@@itemize}, but the command allows +you to specify a name or heading line for each item. (@xref{itemize, +, @code{@@itemize}}.) The @code{@@table} command is used to produce +two-column tables, and is especially useful for glossaries and +explanatory exhibits.@refill @menu * table:: How to construct a two-column table. -* ftable vtable:: Automatic indexing for two-column tables. +* ftable vtable:: How to construct a two-column table + with automatic indexing. * itemx:: How to put more entries in the first column. @end menu @@ -8014,27 +7778,25 @@ @end ifinfo Write the @code{@@table} command at the beginning of a line and follow -it on the same line with an argument that is a Texinfo ``indicating'' -command such as @code{@@code}, @code{@@samp}, @code{@@var}, or -@code{@@kbd} (@pxref{Indicating}). Although these commands are usually -followed by arguments in braces, in this case you use the command name -without an argument because @code{@@item} will supply the argument. -This command will be applied to the text that goes into the first column -of each item and determines how it will be highlighted. For example, -@code{@@code} will cause the text in the first column to be highlighted -with an @code{@@code} command. (We recommend @code{@@code} for -@code{@@table}'s of command-line options.) - -@findex asis +it on the same line with an argument that is a Texinfo command such as +@code{@@code}, @code{@@samp}, @code{@@var}, or @code{@@kbd}. +Although these commands are usually followed by arguments in braces, +in this case you use the command name without an argument because +@code{@@item} will supply the argument. This command will be applied +to the text that goes into the first column of each item and +determines how it will be highlighted. For example, @code{@@samp} +will cause the text in the first column to be highlighted with an +@code{@@samp} command.@refill + You may also choose to use the @code{@@asis} command as an argument to -@code{@@table}. @code{@@asis} is a command that does nothing; if you -use this command after @code{@@table}, @TeX{} and the Info formatting -commands output the first column entries without added highlighting -(``as is'').@refill +@code{@@table}. @code{@@asis} is a command that does nothing; if you use this +command after @code{@@table}, @TeX{} and the Info formatting commands +output the first column entries without added highlighting (`as +is').@refill (The @code{@@table} command may work with other commands besides those -listed here. However, you can only use commands that normally take -arguments in braces.)@refill +listed here. However, you can only use commands +that normally take arguments in braces.)@refill Begin each table entry with an @code{@@item} command at the beginning of a line. Write the first column text on the same line as the @@ -8084,7 +7846,7 @@ @node ftable vtable, itemx, table, Two-column Tables @comment node-name, next, previous, up -@subsection @code{@@ftable} and @code{@@vtable} +@subsection @code{@@ftable} and @code{@@vtable} @cindex Tables with indexes @cindex Indexing table entries automatically @findex ftable @@ -8107,20 +7869,18 @@ with an @code{@@end ftable} or @code{@@end vtable} command on a line by itself. -See the example for @code{@@table} in the previous section. - @node itemx, , ftable vtable, Two-column Tables @comment node-name, next, previous, up @subsection @code{@@itemx} @cindex Two named items for @code{@@table} @findex itemx -Use the @code{@@itemx} command inside a table when you have two or more -first column entries for the same item, each of which should appear on a -line of its own. Use @code{@@itemx} for all but the first entry; -@code{@@itemx} should always follow an @code{@@item} command. The -@code{@@itemx} command works exactly like @code{@@item} except that it -does not generate extra vertical space above the first column text. +Use the @code{@@itemx} command inside a table when you have two or +more first column entries for the same item, each of which should +appear on a line of its own. Use @code{@@itemx} for all but the first +entry. The @code{@@itemx} command works exactly like @code{@@item} +except that it does not generate extra vertical space above the first +column text.@refill @need 1000 For example, @@ -8152,128 +7912,6 @@ (Note also that this example illustrates multi-line supporting text in a two-column table.)@refill - -@node Multi-column Tables, , Two-column Tables, Lists and Tables -@section Multi-column Tables -@cindex Tables, making multi-column -@findex multitable - -@code{@@multitable} allows you to construct tables with any number of -columns, with each column having any width you like. - -You define the column widths on the @code{@@multitable} line itself, and -write each row of the actual table following an @code{@@item} command, -with columns separated by an @code{@@tab} command. Finally, @code{@@end -multitable} completes the table. Details in the sections below. - -@menu -* Multitable Column Widths:: Defining multitable column widths. -* Multitable Rows:: Defining multitable rows, with examples. -@end menu - -@node Multitable Column Widths, Multitable Rows, Multi-column Tables, Multi-column Tables -@subsection Multitable Column Widths -@cindex Multitable column widths -@cindex Column widths, defining for multitables -@cindex Widths, defining multitable column - -You can define the column widths for a multitable in two ways: as -fractions of the line length; or with a prototype row. Mixing the two -methods is not supported. In either case, the widths are defined -entirely on the same line as the @code{@@multitable} command. - -@enumerate -@item -@findex columnfractions -@cindex Line length, column widths as fraction of -To specify column widths as fractions of the line length, write -@code{@@columnfractions} and the decimal numbers (presumably less than -1) after the @code{@@multitable} command, as in: - -@example -@@multitable @@columnfractions .33 .33 .33 -@end example - -@noindent The fractions need not add up exactly to 1.0, as these do -not. This allows you to produce tables that do not need the full line -length. - -@item -@cindex Prototype row, column widths defined by -To specify a prototype row, write the longest entry for each column -enclosed in braces after the @code{@@multitable} command. For example: - -@example -@@multitable @{some text for column one@} @{for column two@} -@end example - -@noindent -The first column will then have the width of the typeset `some text for -column one', and the second column the width of `for column two'. - -The prototype entries need not appear in the table itself. - -Although we used simple text in this example, the prototype entries can -contain Texinfo commands; markup commands such as @code{@@code} are -particularly likely to be useful. - -@end enumerate - - -@node Multitable Rows, , Multitable Column Widths, Multi-column Tables -@subsection Multitable Rows -@cindex Multitable rows -@cindex Rows, of a multitable - -@findex item -@cindex tab -After the @code{@@multitable} command defining the column widths (see -the previous section), you begin each row in the body of a multitable -with @code{@@item}, and separate the column entries with @code{@@tab}. -Line breaks are not special within the table body, and you may break -input lines in your source file as necessary. - -Here is a complete example of a multi-column table (the text is from -@cite{The GNU Emacs Manual}, @pxref{Split Window,, Splitting Windows, -emacs, The GNU Emacs Manual}): - -@example -@@multitable @@columnfractions .15 .45 .4 -@@item Key @@tab Command @@tab Description -@@item C-x 2 -@@tab @@code@{split-window-vertically@} -@@tab Split the selected window into two windows, -with one above the other. -@@item C-x 3 -@@tab @@code@{split-window-horizontally@} -@@tab Split the selected window into two windows -positioned side by side. -@@item C-Mouse-2 -@@tab -@@tab In the mode line or scroll bar of a window, -split that window. -@@end multitable -@end example - -@noindent produces: - -@multitable @columnfractions .15 .45 .4 -@item Key @tab Command @tab Description -@item C-x 2 -@tab @code{split-window-vertically} -@tab Split the selected window into two windows, -with one above the other. -@item C-x 3 -@tab @code{split-window-horizontally} -@tab Split the selected window into two windows -positioned side by side. -@item C-Mouse-2 -@tab -@tab In the mode line or scroll bar of a window, -split that window. -@end multitable - - @node Indices, Insertions, Lists and Tables, Top @comment node-name, next, previous, up @chapter Creating Indices @@ -8437,8 +8075,8 @@ Text}).@refill @cindex Index font types -@cindex Predefined indexing commands -@cindex Indexing commands, predefined +@cindex Predefined indexing commands +@cindex Indexing commands, predefined The six indexing commands for predefined indices are: @table @code @@ -8612,9 +8250,9 @@ at the end of a book or creating an index menu in an Info file.@refill @node New Indices, , Combining Indices, Indices -@section Defining New Indices -@cindex Defining new indices -@cindex Indices, defining new +@section Defining New Indices +@cindex Defining new indices +@cindex Indices, defining new @cindex New index defining @findex defindex @findex defcodeindex @@ -8678,127 +8316,117 @@ line of a Texinfo file, before any @code{@@synindex} or @code{@@syncodeindex} commands (@pxref{Header}).@refill -@node Insertions, Breaks, Indices, Top +@node Insertions, Glyphs, Indices, Top @comment node-name, next, previous, up @chapter Special Insertions @cindex Inserting special characters and symbols @cindex Special insertions -Texinfo provides several commands for inserting characters that have -special meaning in Texinfo, such as braces, and for other graphic -elements that do not correspond to simple characters you can type. +Texinfo provides several commands for formatting dimensions, for +inserting single characters that have special meaning in Texinfo, such +as braces, and for inserting special graphic symbols that do not +correspond to characters, such as dots and bullets.@refill @iftex These are: @itemize @bullet -@item Braces, @samp{@@} and periods. -@item Whitespace within and around a sentence. -@item Accents. -@item Dots and bullets. -@item The @TeX{} logo and the copyright symbol. -@item Mathematical expressions. +@item +Braces, @samp{@@} and periods. + +@item +Format a dimension, such as @samp{12@dmn{pt}}. + +@item +Dots and bullets. + +@item +The @TeX{} logo and the copyright symbol. + +@item +A minus sign. @end itemize @end iftex @menu -* Braces Atsigns:: How to insert braces, @samp{@@}. -* Inserting Space:: How to insert the right amount of space - within a sentence. -* Inserting Accents:: How to insert accents and special characters. +* Braces Atsigns Periods:: How to insert braces, @samp{@@} and periods. +* dmn:: How to format a dimension. * Dots Bullets:: How to insert dots and bullets. -* TeX and copyright:: How to insert the @TeX{} logo +* TeX and copyright:: How to insert the @TeX{} logo and the copyright symbol. -* pounds:: How to insert the pounds currency symbol. * minus:: How to insert a minus sign. * math:: How to format a mathematical expression. -* Glyphs:: How to indicate results of evaluation, - expansion of macros, errors, etc. -* Images:: How to include graphics. @end menu - -@node Braces Atsigns, Inserting Space, Insertions, Insertions -@section Inserting @@ and Braces -@cindex Inserting @@, braces +@node Braces Atsigns Periods, dmn, Insertions, Insertions +@comment node-name, next, previous, up +@section Inserting @samp{@@}, Braces, and Periods +@cindex Inserting @@, braces, and periods @cindex Braces, inserting -@cindex Special characters, commands to insert -@cindex Commands to insert special characters - -@samp{@@} and curly braces are special characters in Texinfo. To insert -these characters so they appear in text, you must put an @samp{@@} in -front of these characters to prevent Texinfo from misinterpreting -them. +@cindex Periods, inserting +@cindex Single characters, commands to insert +@cindex Commands to insert single characters + +@samp{@@} and curly braces are special characters in Texinfo. To +insert these characters so they appear in text, you must put an @samp{@@} in front +of these characters to prevent Texinfo from misinterpreting them.@refill + +Periods are also special. Depending on whether the period is inside +or at the end of a sentence, less or more space is inserted after a +period in a typeset manual. Since it is not always possible for +Texinfo to determine when a period ends a sentence and when it is used +in an abbreviation, special commands are needed in some circumstances. +(Usually, Texinfo can guess how to handle periods, so you do not need +to use the special commands; you just enter a period as you would if +you were using a typewriter, which means you put two spaces after the +period, question mark, or exclamation mark that ends a +sentence.)@refill Do not put braces after any of these commands; they are not -necessary. +necessary.@refill @menu -* Inserting An Atsign:: How to insert @samp{@@}. -* Inserting Braces:: How to insert @samp{@{} and @samp{@}}. +* Inserting An Atsign:: +* Inserting Braces:: How to insert @samp{@{} and @samp{@}} +* Controlling Spacing:: How to insert the right amount of space + after punctuation within a sentence. @end menu -@node Inserting An Atsign, Inserting Braces, Braces Atsigns, Braces Atsigns +@node Inserting An Atsign, Inserting Braces, Braces Atsigns Periods, Braces Atsigns Periods +@comment node-name, next, previous, up @subsection Inserting @samp{@@} with @@@@ @findex @@ @r{(single @samp{@@})} @code{@@@@} stands for a single @samp{@@} in either printed or Info -output. - -Do not put braces after an @code{@@@@} command. - -@node Inserting Braces, , Inserting An Atsign, Braces Atsigns +output.@refill + +Do not put braces after an @code{@@@@} command.@refill + +@node Inserting Braces, Controlling Spacing, Inserting An Atsign, Braces Atsigns Periods +@comment node-name, next, previous, up @subsection Inserting @samp{@{} and @samp{@}}with @@@{ and @@@} @findex @{ @r{(single @samp{@{})} @findex @} @r{(single @samp{@}})} @code{@@@{} stands for a single @samp{@{} in either printed or Info -output. +output.@refill @code{@@@}} stands for a single @samp{@}} in either printed or Info -output. - -Do not put braces after either an @code{@@@{} or an @code{@@@}} -command. - - -@node Inserting Space, Inserting Accents, Braces Atsigns, Insertions -@section Inserting Space - -@cindex Inserting space -@cindex Spacing, inserting -@cindex Whitespace, inserting -The following sections describe commands that control spacing of various -kinds within and after sentences. - -@menu -* Not Ending a Sentence:: Sometimes a . doesn't end a sentence. -* Ending a Sentence:: Sometimes it does. -* Multiple Spaces:: Inserting multiple spaces. -* dmn:: How to format a dimension. -@end menu - -@node Not Ending a Sentence, Ending a Sentence, Inserting Space, Inserting Space -@subsection Not Ending a Sentence - -@cindex Not ending a sentence -@cindex Sentence non-ending punctuation -@cindex Periods, inserting -Depending on whether a period or exclamation point or question mark is -inside or at the end of a sentence, less or more space is inserted after -a period in a typeset manual. Since it is not always possible for -Texinfo to determine when a period ends a sentence and when it is used -in an abbreviation, special commands are needed in some circumstances. -(Usually, Texinfo can guess how to handle periods, so you do not need to -use the special commands; you just enter a period as you would if you -were using a typewriter, which means you put two spaces after the -period, question mark, or exclamation mark that ends a sentence.) - +output.@refill + +Do not put braces after either an @code{@@@{} or an @code{@@@}} +command.@refill + +@node Controlling Spacing, , Inserting Braces, Braces Atsigns Periods +@comment node-name, next, previous, up +@subsection Spacing After Colons and Periods @findex : @r{(suppress widening)} + Use the @code{@@:}@: command after a period, question mark, exclamation mark, or colon that should not be followed by extra space. For example, use @code{@@:}@: after periods that end abbreviations -which are not at the ends of sentences. +which are not at the ends of sentences. @code{@@:}@: has no effect on +the Info file output.@refill @need 700 For example, @@ -8824,27 +8452,14 @@ @end quotation @noindent -(Incidentally, @samp{s.o.p.} is an abbreviation for ``Standard Operating -Procedure''.) - -@code{@@:} has no effect on the Info output. Do not put braces after -@code{@@:}. - - -@node Ending a Sentence, Multiple Spaces, Not Ending a Sentence, Inserting Space -@subsection Ending a Sentence - -@cindex Ending a Sentence -@cindex Sentence ending punctuation - -@findex . @r{(end of sentence)} -@findex ! @r{(end of sentence)} -@findex ? @r{(end of sentence)} -Use @code{@@.}@: instead of a period, @code{@@!}@: instead of an -exclamation point, and @code{@@?}@: instead of a question mark at the end -of a sentence that ends with a single capital letter. Otherwise, @TeX{} -will think the letter is an abbreviation and will not insert the correct -end-of-sentence spacing. Here is an example: +@kbd{@@:} has no effect on the Info output. (@samp{s.o.p} is an acronym +for ``Standard Operating Procedure''.) + +@findex . @r{(true end of sentence)} +Use @code{@@.}@: instead of a period at the end of a sentence that +ends with a single capital letter. Otherwise, @TeX{} will think the +letter is an abbreviation and will not insert the correct +end-of-sentence spacing. Here is an example:@refill @example Give it to M.I.B. and to M.E.W@@. Also, give it to R.J.C@@. @@ -8858,7 +8473,7 @@ @iftex produces the following. If you look carefully at this printed output, you will see a little more whitespace after the @samp{W} in the first -line. +line.@refill @end iftex @quotation @@ -8867,63 +8482,17 @@ @end quotation In the Info file output, @code{@@.}@: is equivalent to a simple -@samp{.}; likewise for @code{@@!}@: and @code{@@?}@:. - -The meanings of @code{@@:} and @code{@@.}@: in Texinfo are designed to -work well with the Emacs sentence motion commands (@pxref{Sentences,,, -emacs, The GNU Emacs Manual}). This made it necessary for them to be -incompatible with some other formatting systems that use @@-commands. - -Do not put braces after any of these commands. - - -@node Multiple Spaces, dmn, Ending a Sentence, Inserting Space -@subsection Multiple Spaces - -@cindex Multiple spaces -@cindex Whitespace, inserting -@findex (space) -@findex (tab) -@findex (newline) - -Ordinarily, @TeX{} collapses multiple whitespace characters (space, tab, -and newline) into a single space. Info output, on the other hand, -preserves whitespace as you type it, except for changing a newline into -a space; this is why it is important to put two spaces at the end of -sentences in Texinfo documents. - -Occasionally, you may want to actually insert several consecutive -spaces, either for purposes of example (what your program does with -multiple spaces as input), or merely for purposes of appearance in -headings or lists. Texinfo supports three commands: -@code{@@@kbd{SPACE}}, @code{@@@kbd{TAB}}, and @code{@@@kbd{NL}}, all of -which insert a single space into the output. (Here, -@code{@@@kbd{SPACE}} represents an @samp{@@} character followed by a -space, i.e., @samp{@@ }, and @kbd{TAB} and @kbd{NL} represent the tab -character and end-of-line, i.e., when @samp{@@} is the last character on -a line.) - -For example, -@example -Spacey@@ @@ @@ @@ -example. -@end example - -@noindent produces - -@example -Spacey@ @ @ @ -example. -@end example - -Other possible uses of @code{@@@kbd{SPACE}} have been subsumed by -@code{@@multitable} (@pxref{Multi-column Tables}). - -Do not follow any of these commands with braces. - - -@node dmn, , Multiple Spaces, Inserting Space -@subsection @code{@@dmn}@{@var{dimension}@}: Format a Dimension +@samp{.}.@refill + +The meanings of @code{@@:}@: and @code{@@.}@: in Texinfo are designed +to work well with the Emacs sentence motion commands. This made it +necessary for them to be incompatible with some other formatting +systems that use @@-commands.@refill + +Do not put braces after either an @code{@@:} or an @code{@@.} command.@refill + +@node dmn, Dots Bullets, Braces Atsigns Periods, Insertions +@section @code{@@dmn}@{@var{dimension}@}: Format a Dimension @cindex Thin space between number, dimension @cindex Dimension formatting @cindex Format a dimension @@ -8938,7 +8507,11 @@ To use the @code{@@dmn} command, write the number and then follow it immediately, with no intervening space, by @code{@@dmn}, and then by -the dimension within braces. For example, +the dimension within braces.@refill + +@need 700 +@noindent +For example, @example A4 paper is 8.27@@dmn@{in@} wide. @@ -8951,129 +8524,17 @@ A4 paper is 8.27@dmn{in} wide. @end quotation -Not everyone uses this style. Some people prefer @w{@samp{8.27 in.@@:}} -or @w{@samp{8.27 inches}} to @samp{8.27@@dmn@{in@}} in the Texinfo file. -In these cases, however, the formatters may insert a line break between -the number and the dimension, so use @code{@@w} (@pxref{w}). Also, if -you write a period after an abbreviation within a sentence, you should -write @samp{@@:} after the period to prevent @TeX{} from inserting extra -whitespace, as shown here. @xref{Inserting Space}. - - -@node Inserting Accents, Dots Bullets, Inserting Space, Insertions -@section Inserting Accents - -@cindex Inserting accents -@cindex Accents, inserting -@cindex Floating accents, inserting - -Here is a table with the commands Texinfo provides for inserting -floating accents. The commands with non-alphabetic names do not take -braces around their argument (which is taken to be the next character). -(Exception: @code{@@,} @emph{does} take braces around its argument.) -This is so as to make the source as convenient to type and read as -possible, since accented characters are very common in some languages. - -@findex " -@cindex Umlaut accent -@findex ' -@cindex Acute accent -@findex = -@cindex Macron accent -@findex ^ -@cindex Circumflex accent -@findex ` -@cindex Grave accent -@findex ~ -@cindex Tilde accent -@findex , -@cindex Cedilla accent -@findex dotaccent -@cindex Dot accent -@findex H -@cindex Hungariam umlaut accent -@findex ringaccent -@cindex Ring accent -@findex tieaccent -@cindex Tie-after accent -@findex u -@cindex Breve accent -@findex ubaraccent -@cindex Underbar accent -@findex udotaccent -@cindex Underdot accent -@findex v -@cindex Check accent -@multitable {@@questiondown@{@}} {Output} {macron/overbar accent} -@item Command @tab Output @tab What -@item @t{@@"o} @tab @"o @tab umlaut accent -@item @t{@@'o} @tab @'o @tab acute accent -@item @t{@@,@{c@}} @tab @,{c} @tab cedilla accent -@item @t{@@=o} @tab @=o @tab macron/overbar accent -@item @t{@@^o} @tab @^o @tab circumflex accent -@item @t{@@`o} @tab @`o @tab grave accent -@item @t{@@~o} @tab @~o @tab tilde accent -@item @t{@@dotaccent@{o@}} @tab @dotaccent{o} @tab overdot accent -@item @t{@@H@{o@}} @tab @H{o} @tab long Hungarian umlaut -@item @t{@@ringaccent@{o@}} @tab @ringaccent{o} @tab ring accent -@item @t{@@tieaccent@{oo@}} @tab @tieaccent{oo} @tab tie-after accent -@item @t{@@u@{o@}} @tab @u{o} @tab breve accent -@item @t{@@ubaraccent@{o@}} @tab @ubaraccent{o} @tab underbar accent -@item @t{@@udotaccent@{o@}} @tab @udotaccent{o} @tab underdot accent -@item @t{@@v@{o@}} @tab @v{o} @tab hacek or check accent -@end multitable - -This table lists the Texinfo commands for inserting other characters -commonly used in languages other than English. - -@findex questiondown -@cindex @questiondown{} -@findex exclamdown -@cindex @exclamdown{} -@findex aa -@cindex @aa{} -@findex AA -@cindex @AA{} -@findex ae -@cindex @ae{} -@findex AE -@cindex @AE{} -@findex dotless -@cindex @dotless{i} -@cindex @dotless{j} -@cindex Dotless i, j -@findex l -@cindex @l{} -@findex L -@cindex @L{} -@findex o -@cindex @o{} -@findex O -@cindex @O{} -@findex oe -@cindex @oe{} -@findex OE -@cindex @OE{} -@findex ss -@cindex @ss{} -@cindex Es-zet -@cindex Sharp S -@cindex German S -@multitable {@@questiondown@{@}} {oe,OE} {es-zet or sharp S} -@item @t{@@exclamdown@{@}} @tab @exclamdown{} @tab upside-down ! -@item @t{@@questiondown@{@}} @tab @questiondown{} @tab upside-down ? -@item @t{@@aa@{@},@@AA@{@}} @tab @aa{},@AA{} @tab A,a with circle -@item @t{@@ae@{@},@@AE@{@}} @tab @ae{},@AE{} @tab ae,AE ligatures -@item @t{@@dotless@{i@}} @tab @dotless{i} @tab dotless i -@item @t{@@dotless@{j@}} @tab @dotless{j} @tab dotless j -@item @t{@@l@{@},@@L@{@}} @tab @l{},@L{} @tab suppressed-L,l -@item @t{@@o@{@},@@O@{@}} @tab @o{},@O{} @tab O,o with slash -@item @t{@@oe@{@},@@OE@{@}} @tab @oe{},@OE{} @tab OE,oe ligatures -@item @t{@@ss@{@}} @tab @ss{} @tab es-zet or sharp S -@end multitable - - -@node Dots Bullets, TeX and copyright, Inserting Accents, Insertions +Not everyone uses this style. Instead of writing +@w{@samp{8.27@@dmn@{in@}}} in the Texinfo file, you may write +@w{@samp{8.27 in.}} or @w{@samp{8.27 inches}}. (In these cases, the +formatters may insert a line break between the number and the +dimension. Also, if you write a period after an abbreviation within a +sentence, you should write @samp{@@:} after the period to prevent +@TeX{} from inserting extra whitespace. @xref{Controlling Spacing, , +Spacing After Colons and Periods}.)@refill + +@node Dots Bullets, TeX and copyright, dmn, Insertions +@comment node-name, next, previous, up @section Inserting Ellipsis, Dots, and Bullets @cindex Dots, inserting @cindex Bullets, inserting @@ -9097,9 +8558,9 @@ * bullet:: How to insert a bullet. @end menu - @node dots, bullet, Dots Bullets, Dots Bullets -@subsection @code{@@dots}@{@} (@dots{}) +@comment node-name, next, previous, up +@subsection @code{@@dots}@{@} @findex dots @cindex Inserting dots @cindex Dots, inserting @@ -9108,22 +8569,23 @@ three dots in a row, appropriately spaced, like this: `@dots{}'. Do not simply write three periods in the input file; that would work for the Info file output, but would produce the wrong amount of space -between the periods in the printed manual. - -Similarly, the @code{@@enddots@{@}} command generates an -end-of-sentence ellipsis (four dots) @enddots{} +between the periods in the printed manual.@refill + +Similarly, the @code{@@enddots@{@}} command helps you correctly set an +end-of-sentence ellipsis (four dots). @iftex Here is an ellipsis: @dots{} + Here are three periods in a row: ... In printed output, the three periods in a row are closer together than the dots in the ellipsis. @end iftex - @node bullet, , dots, Dots Bullets -@subsection @code{@@bullet}@{@} (@bullet{}) +@comment node-name, next, previous, up +@subsection @code{@@bullet}@{@} @findex bullet Use the @code{@@bullet@{@}} command to generate a large round dot, or @@ -9132,11 +8594,11 @@ Here is a bullet: @bullet{} When you use @code{@@bullet} in @code{@@itemize}, you do not need to -type the braces, because @code{@@itemize} supplies them. +type the braces, because @code{@@itemize} supplies them. (@xref{itemize, , @code{@@itemize}}.)@refill - -@node TeX and copyright, pounds, Dots Bullets, Insertions +@node TeX and copyright, minus, Dots Bullets, Insertions +@comment node-name, next, previous, up @section Inserting @TeX{} and the Copyright Symbol The logo `@TeX{}' is typeset in a special fashion and it needs an @@ -9150,68 +8612,57 @@ * copyright symbol:: How to use @code{@@copyright}@{@}. @end menu - @node tex, copyright symbol, TeX and copyright, TeX and copyright -@subsection @code{@@TeX}@{@} (@TeX{}) +@comment node-name, next, previous, up +@subsection @code{@@TeX}@{@} @findex tex (command) Use the @code{@@TeX@{@}} command to generate `@TeX{}'. In a printed manual, this is a special logo that is different from three ordinary letters. In Info, it just looks like @samp{TeX}. The @code{@@TeX@{@}} command is unique among Texinfo commands in that the -@kbd{T} and the @kbd{X} are in upper case.@refill - +@key{T} and the @key{X} are in upper case.@refill @node copyright symbol, , tex, TeX and copyright -@subsection @code{@@copyright}@{@} (@copyright{}) +@comment node-name, next, previous, up +@subsection @code{@@copyright}@{@} @findex copyright Use the @code{@@copyright@{@}} command to generate `@copyright{}'. In a printed manual, this is a @samp{c} inside a circle, and in Info, this is @samp{(C)}.@refill - -@node pounds, minus, TeX and copyright, Insertions -@section @code{@@pounds}@{@} (@pounds{}): Pounds Sterling -@findex pounds - -Use the @code{@@pounds@{@}} command to generate `@pounds{}'. In a -printed manual, this is the symbol for the currency pounds sterling. -In Info, it is a @samp{#}. Other currency symbols are unfortunately not -available. - - -@node minus, math, pounds, Insertions -@section @code{@@minus}@{@} (@minus{}): Inserting a Minus Sign +@node minus, math, TeX and copyright, Insertions +@section @code{@@minus}@{@}: Inserting a Minus Sign @findex minus Use the @code{@@minus@{@}} command to generate a minus sign. In a fixed-width font, this is a single hyphen, but in a proportional font, the symbol is the customary length for a minus sign---a little longer -than a hyphen, shorter than an em-dash: +than a hyphen.@refill + +You can compare the two forms: @display @samp{@minus{}} is a minus sign generated with @samp{@@minus@{@}}, -`-' is a hyphen generated with the character @samp{-}, - -`---' is an em-dash for text. +`-' is a hyphen generated with the character @samp{-}. @end display @noindent In the fixed-width font used by Info, @code{@@minus@{@}} is the same -as a hyphen. +as a hyphen.@refill You should not use @code{@@minus@{@}} inside @code{@@code} or @code{@@example} because the width distinction is not made in the -fixed-width font they use. +fixed-width font they use.@refill When you use @code{@@minus} to specify the mark beginning each entry in an itemized list, you do not need to type the braces -(@pxref{itemize, , @code{@@itemize}}.) - - -@node math, Glyphs, minus, Insertions +(@pxref{itemize, , @code{@@itemize}}.)@refill + +@node math, , minus, Insertions +@comment node-name, next, previous, up @section @code{@@math}: Inserting Mathematical Expressions @findex math @cindex Mathematical expressions @@ -9244,23 +8695,27 @@ (a + b)(a + b) = a^2 + 2ab + b^2 @end example -Thus, the @code{@@math} command has no effect on the Info output. - -For complex mathematical expressions, you can also use @TeX{} directly -(@pxref{Raw Formatter Commands}). When you use @TeX{} directly, -remember to write the mathematical expression between one or two -@samp{$} (dollar-signs) as appropriate. - - -@node Glyphs, Images, math, Insertions -@section Glyphs for Examples +The @code{@@math} command has no effect on the Info output. Currently, +it has limited effect on typeset output. However, this may change since +@TeX{} itself is designed for mathematical typesetting and does a +splendid job. + +Certainly, for complex mathematical expressions, you could use @TeX{} +directly. @xref{Using Ordinary TeX Commands, , Using Ordinary @TeX{} +Commands}. When you use @TeX{} directly, remember to write the +mathematical expression between one or two @samp{$} (dollar-signs) as +appropriate. + +@node Glyphs, Breaks, Insertions, Top +@comment node-name, next, previous, up +@chapter Glyphs for Examples @cindex Glyphs In Texinfo, code is often illustrated in examples that are delimited by @code{@@example} and @code{@@end example}, or by @code{@@lisp} and @code{@@end lisp}. In such examples, you can indicate the results of evaluation or an expansion using @samp{@result{}} or -@samp{@expansion{}}. Likewise, there are commands to insert glyphs +@samp{@expansion{}}. Likewise, there are commands to insert glyphs to indicate printed output, error messages, equivalence of expressions, and the location of point.@refill @@ -9281,7 +8736,7 @@ @node Glyphs Summary, result, Glyphs, Glyphs @ifinfo -@subheading Glyphs Summary +@heading Glyphs Summary Here are the different glyph commands:@refill @end ifinfo @@ -9307,18 +8762,8 @@ @code{@@point@{@}} shows the location of point.@refill @end table - -@menu -* result:: -* expansion:: -* Print Glyph:: -* Error Glyph:: -* Equivalence:: -* Point Glyph:: -@end menu - @node result, expansion, Glyphs Summary, Glyphs -@subsection @code{@@result@{@}} (@result{}): Indicating Evaluation +@section @result{}: Indicating Evaluation @cindex Result of an expression @cindex Indicating evaluation @cindex Evaluation glyph @@ -9346,9 +8791,8 @@ @noindent may be read as ``@code{(cdr '(1 2 3))} evaluates to @code{(2 3)}''. - @node expansion, Print Glyph, result, Glyphs -@subsection @code{@@expansion@{@}} (@expansion{}): Indicating an Expansion +@section @expansion{}: Indicating an Expansion @cindex Expansion, indicating it When an expression is a macro call, it expands into a new expression. @@ -9389,7 +8833,7 @@ @end lisp @noindent -which may be read as: +which may be read as: @quotation @code{(third '(a b c))} expands to @code{(car (cdr (cdr '(a b c))))}; @@ -9401,9 +8845,8 @@ @code{@@expansion@{@}} and @code{@@result@{@}} commands are indented five spaces.@refill - @node Print Glyph, Error Glyph, expansion, Glyphs -@subsection @code{@@print@{@}} (@print{}): Indicating Printed Output +@section @print{}: Indicating Printed Output @cindex Printed output, indicating it Sometimes an expression will print output during its execution. You @@ -9446,9 +8889,8 @@ @end group @end lisp - @node Error Glyph, Equivalence, Print Glyph, Glyphs -@subsection @code{@@error@{@}} (@error{}): Indicating an Error Message +@section @error{}: Indicating an Error Message @cindex Error message, indicating it A piece of code may cause an error when you evaluate it. You can @@ -9489,11 +8931,11 @@ Wrong type argument: integer-or-marker-p, x @end lisp -@samp{@error{}} itself is not part of the error message. - +Note that @samp{@error{}} itself is not part of the error +message. @node Equivalence, Point Glyph, Error Glyph, Glyphs -@subsection @code{@@equiv@{@}} (@equiv{}): Indicating Equivalence +@section @equiv{}: Indicating Equivalence @cindex Equivalence, indicating it Sometimes two expressions produce identical results. You can indicate the @@ -9527,9 +8969,9 @@ This indicates that evaluating @code{(make-sparse-keymap)} produces identical results to evaluating @code{(list 'keymap)}. - +@c Cannot write point command here because it causes trouble with TOC. @node Point Glyph, , Equivalence, Glyphs -@subsection @code{@@point@{@}} (@point{}): Indicating Point in a Buffer +@section Indicating Point in a Buffer @cindex Point, indicating it in a buffer Sometimes you need to show an example of text in an Emacs buffer. In @@ -9590,93 +9032,8 @@ @@end example @end example - -@c this should be described with figures when we have them -@c perhaps in the quotation/example chapter. -@node Images, , Glyphs, Insertions -@section Inserting Images - -@cindex Images, inserting -@cindex Pictures, inserting -@findex image - -You can insert an image in an external file with the @code{@@image} -command: - -@example -@@image@{@var{filename}, @r{[}@var{width}@r{]}, @r{[}@var{height}@r{]}@} -@end example - -@cindex Formats for images -@cindex Image formats -The @var{filename} argument is mandatory, and must not have an -extension, because the different processors support different formats: -@TeX{} reads the file @file{@var{filename}.eps} (Encapsulated PostScript -format); @code{makeinfo} uses @file{@var{filename}.txt} verbatim for -Info output (more or less as if it was an @code{@@example}). HTML -output requires @file{@var{filename}.jpg}. - -@cindex Width of images -@cindex Height of images -@cindex Aspect ratio of images -@cindex Distorting images -The optional @var{width} and @var{height} arguments specify the size to -scale the image to (they are ignored for Info output). If they are both -specified, the image is presented in its natural size (given in the -file); if only one is specified, the other is scaled proportionately; -and if both are specified, both are respected, thus possibly distorting -the original image by changing its aspect ratio. - -@cindex Dimensions and image sizes -The @var{width} and @var{height} may be specified using any valid @TeX{} -dimension, namely: - -@table @asis -@item pt -@cindex Points (dimension) -point (72.27pt = 1in) -@item pc -@cindex Picas -pica (1pc = 12pt) -@item bp -@cindex Big points -big point (72bp = 1in) -@item in -@cindex Inches -inch -@item cm -@cindex Centimeters -centimeter (2.54cm = 1in) -@item mm -@cindex Millimeters -millimeter (10mm = 1cm) -@item dd -@cindex Did@^ot points -did@^ot point (1157dd = 1238pt) -@item cc -@cindex Ciceros -cicero (1cc = 12dd) -@item sp -@cindex Scaled points -scaled point (65536sp = 1pt) -@end table - -@pindex ridt.eps -For example, the following will scale a file @file{ridt.eps} to one -inch vertically, with the width scaled proportionately: - -@example -@@image@{ridt,,1in@} -@end example - -@pindex epsf.tex -For @code{@@image} to work with @TeX{}, the file @file{epsf.tex} must be -installed somewhere that @TeX{} can find it. This file is included in -the Texinfo distribution and is available from -@uref{ftp://ftp.tug.org/tex/epsf.tex}. - - -@node Breaks, Definition Commands, Insertions, Top +@node Breaks, Definition Commands, Glyphs, Top +@comment node-name, next, previous, up @chapter Making and Preventing Breaks @cindex Making line and page breaks @cindex Preventing line and page breaks @@ -9698,8 +9055,7 @@ @menu * Break Commands:: Cause and prevent splits. * Line Breaks:: How to force a single line to use two lines. -* - and hyphenation:: How to tell TeX about hyphenation points. -* w:: How to prevent unwanted line breaks. +* w:: How to prevent unwanted line breaks. * sp:: How to insert blank lines. * page:: How to force the start of a new page. * group:: How to prevent unwanted page breaks. @@ -9714,7 +9070,7 @@ @sp 1 @end iftex -The break commands create or allow line and paragraph breaks:@refill +The break commands create line and paragraph breaks:@refill @table @code @item @@* @@ -9722,13 +9078,10 @@ @item @@sp @var{n} Skip @var{n} blank lines.@refill - -@item @@- -Insert a discretionary hyphen. - -@item @@hyphenation@{@var{hy-phen-a-ted words}@} -Define hyphen points in @var{hy-phen-a-ted words}. -@end table +@end table +@iftex +@sp 1 +@end iftex The line-break-prevention command holds text together all on one line:@refill @@ -9755,7 +9108,7 @@ Start a new printed page if not enough space on this one.@refill @end table -@node Line Breaks, - and hyphenation, Break Commands, Breaks +@node Line Breaks, w, Break Commands, Breaks @comment node-name, next, previous, up @section @code{@@*}: Generate Line Breaks @findex * @r{(force line break)} @@ -9811,64 +9164,32 @@ break.@refill @end quotation -@node - and hyphenation, w, Line Breaks, Breaks -@section @code{@@-} and @code{@@hyphenation}: Helping @TeX{} hyphenate - -@findex - -@findex hyphenation -@cindex Hyphenation, helping @TeX{} do -@cindex Fine-tuning, and hyphenation - -Although @TeX{}'s hyphenation algorithm is generally pretty good, it -does miss useful hyphenation points from time to time. (Or, far more -rarely, insert an incorrect hyphenation.) So, for documents with an -unusual vocabulary or when fine-tuning for a printed edition, you may -wish to help @TeX{} out. Texinfo supports two commands for this: - -@table @code -@item @@- -Insert a discretionary hyphen, i.e., a place where @TeX{} can (but does -not have to) hyphenate. This is especially useful when you notice -an overfull hbox is due to @TeX{} missing a hyphenation (@pxref{Overfull -hboxes}). @TeX{} will not insert any hyphenation points in a word -containing @code{@@-}. - -@item @@hyphenation@{@var{hy-phen-a-ted words}@} -Tell @TeX{} how to hyphenate @var{hy-phen-a-ted words}. As shown, you -put a @samp{-} at each hyphenation point. For example: -@example -@@hyphenation@{man-u-script man-u-scripts@} -@end example -@noindent @TeX{} only uses the specified hyphenation points when the -words match exactly, so give all necessary variants. -@end table - -Info output is not hyphenated, so these commands have no effect there. - -@node w, sp, - and hyphenation, Breaks +@node w, sp, Line Breaks, Breaks @comment node-name, next, previous, up @section @code{@@w}@{@var{text}@}: Prevent Line Breaks @findex w @r{(prevent line break)} @cindex Line breaks, preventing -@cindex Hyphenation, preventing @code{@@w@{@var{text}@}} outputs @var{text} and prohibits line breaks within @var{text}.@refill You can use the @code{@@w} command to prevent @TeX{} from automatically -hyphenating a long name or phrase that happens to fall near the end of a -line.@refill - -@example -You can copy GNU software from @@w@{@@samp@{ftp.gnu.ai.mit.edu@}@}. +hyphenating a long name or phrase that accidentally falls near the end +of a line.@refill + +@example +You can copy GNU software from @@w@{@@file@{prep.ai.mit.edu@}@}. @end example @noindent produces @quotation -You can copy GNU software from @w{@samp{ftp.gnu.ai.mit.edu}}. -@end quotation +You can copy GNU software from @w{@file{prep.ai.mit.edu}}. +@end quotation + +In the Texinfo file, you must write the @code{@@w} command and its +argument (all the affected text) all on one line.@refill @quotation @strong{Caution:} Do not write an @code{@@refill} command at the end @@ -9895,7 +9216,7 @@ @end example @noindent -generates two blank lines. +generates two blank lines. The @code{@@sp} command is most often used in the title page.@refill @@ -9928,7 +9249,7 @@ @example @group -This line +This line contains and is ended by paragraph breaks @@ -10101,7 +9422,7 @@ @example @group @@deffn Command forward-word count -This command moves point forward @@var@{count@} words +This command moves point forward @@var@{count@} words (or backward if @@var@{count@} is negative). @dots{} @@end deffn @end group @@ -10123,8 +9444,8 @@ @example @group -@@deffn @{Interactive Command@} isearch-forward -@dots{} +@@deffn @{Interactive Command@} isearch-forward +@dots{} @@end deffn @end group @end example @@ -10140,10 +9461,9 @@ belongs. The @code{@@deffn} command possesses three predefined, specialized variations, @code{@@defun}, @code{@@defmac}, and @code{@@defspec}, that specify the category for you: ``Function'', -``Macro'', and ``Special Form'' respectively. (In Lisp, a special form -is an entity much like a function.) The @code{@@defvr} command also is -accompanied by several predefined, specialized variations for describing -particular kinds of variables.@refill +``Macro'', and ``Special Form'' respectively. The @code{@@defvr} +command also is accompanied by several predefined, specialized +variations for describing particular kinds of variables.@refill The template for a specialized definition, such as @code{@@defun}, is similar to the template for a generalized definition, except that you @@ -10151,7 +9471,7 @@ @example @group -@@defun @var{name} @var{arguments}@dots{} +@@defun @var{name} @var{arguments}@dots{} @var{body-of-definition} @@end defun @end group @@ -10162,10 +9482,10 @@ @example @group -@@defun buffer-end flag +@@defun buffer-end flag This function returns @@code@{(point-min)@} if @@var@{flag@} is less than 1, @@code@{(point-max)@} otherwise. -@dots{} +@dots{} @@end defun @end group @end example @@ -10206,22 +9526,22 @@ An argument enclosed within square brackets is optional. Thus, the phrase @samp{@code{@r{[}@var{optional-arg}@r{]}}} means that -@var{optional-arg} is optional. +@var{optional-arg} is optional. An argument followed by an ellipsis is optional -and may be repeated more than once. +and may be repeated more than once. @c This is consistent with Emacs Lisp Reference manual -Thus, @samp{@var{repeated-args}@dots{}} stands for zero or more arguments. +Thus, @samp{@var{repeated-args}@dots{}} stands for zero or more arguments. Parentheses are used when several arguments are grouped -into additional levels of list structure in Lisp. +into additional levels of list structure in Lisp. @end iftex @c The following looks better in Info (no `r', `samp' and `code'): @ifinfo -An argument enclosed within square brackets is optional. -Thus, [@var{optional-arg}] means that @var{optional-arg} is optional. -An argument followed by an ellipsis is optional -and may be repeated more than once. +An argument enclosed within square brackets is optional. +Thus, [@var{optional-arg}] means that @var{optional-arg} is optional. +An argument followed by an ellipsis is optional +and may be repeated more than once. @c This is consistent with Emacs Lisp Reference manual -Thus, @var{repeated-args}@dots{} stands for zero or more arguments. +Thus, @var{repeated-args}@dots{} stands for zero or more arguments. Parentheses are used when several arguments are grouped into additional levels of list structure in Lisp. @end ifinfo @@ -10278,9 +9598,9 @@ @example @group -@@deffn @{Interactive Command@} isearch-forward +@@deffn @{Interactive Command@} isearch-forward @@deffnx @{Interactive Command@} isearch-backward -These two search commands are similar except @dots{} +These two search commands are similar except @dots{} @@end deffn @end group @end example @@ -10288,9 +9608,9 @@ @noindent produces -@deffn {Interactive Command} isearch-forward +@deffn {Interactive Command} isearch-forward @deffnx {Interactive Command} isearch-backward -These two search commands are similar except @dots{} +These two search commands are similar except @dots{} @end deffn Each of the other definition commands has an `x' form: @code{@@defunx}, @@ -10346,7 +9666,7 @@ @example @group -@@deffn Command forward-char nchars +@@deffn Command forward-char nchars Move point forward @@var@{nchars@} characters. @@end deffn @end group @@ -10368,7 +9688,7 @@ @example @group @@deffn @var{category} @var{name} @var{arguments}@dots{} -@var{body-of-definition} +@var{body-of-definition} @@end deffn @end group @end example @@ -10403,7 +9723,7 @@ @example @group -@@defun @var{function-name} @var{arguments}@dots{} +@@defun @var{function-name} @var{arguments}@dots{} @var{body-of-definition} @@end defun @end group @@ -10420,8 +9740,7 @@ @findex defspec @item @@defspec @var{name} @var{arguments}@dots{} The @code{@@defspec} command is the definition command for special -forms. (In Lisp, a special form is an entity much like a function, -@pxref{Special Forms,,, elisp, GNU Emacs Lisp Reference Manual}.) +forms. (In Lisp, a special form is an entity much like a function.) @code{@@defspec} is equivalent to @samp{@@deffn @{Special Form@} @dots{}} and works like @code{@@defun}.@refill @end table @@ -10443,17 +9762,17 @@ followed it on the same line by the category of the entity and the name of the entity.@refill -Capitalize the category name like a title. If the name of the category -contains spaces, as in the name ``User Option'', enclose it in braces. -Otherwise, the second word will be mistaken for the name of the entity. -For example, - -@example -@group -@@defvr @{User Option@} fill-column -This buffer-local variable specifies -the maximum width of filled lines. -@dots{} +Capitalize the category name like a title. If the name of the +category contains spaces, as in the name `User Option', write braces +around it. Otherwise, the second word will be mistaken for the name +of the entity, for example: + +@example +@group +@@defvr @{User Option@} fill-column +This buffer-local variable specifies +the maximum width of filled lines. +@dots{} @@end defvr @end group @end example @@ -10465,8 +9784,8 @@ @example @group -@@defvr @var{category} @var{name} -@var{body-of-definition} +@@defvr @var{category} @var{name} +@var{body-of-definition} @@end defvr @end group @end example @@ -10484,8 +9803,8 @@ @example @group -@@defvar kill-ring -@dots{} +@@defvar kill-ring +@dots{} @@end defvar @end group @end example @@ -10494,8 +9813,8 @@ @example @group -@@defvar @var{name} -@var{body-of-definition} +@@defvar @var{name} +@var{body-of-definition} @@end defvar @end group @end example @@ -10505,21 +9824,17 @@ @findex defopt @item @@defopt @var{name} -@cindex User options, marking -The @code{@@defopt} command is the definition command for @dfn{user -options}, i.e., variables intended for users to change according to -taste; Emacs has many such (@pxref{Variables,,, emacs, The GNU Emacs -Manual}). @code{@@defopt} is equivalent to @samp{@@defvr @{User +The @code{@@defopt} command is the definition command for user +options. @code{@@defopt} is equivalent to @samp{@@defvr @{User Option@} @dots{}} and works like @code{@@defvar}.@refill @end table - @node Typed Functions, Typed Variables, Variables Commands, Def Cmds in Detail @subsection Functions in Typed Languages The @code{@@deftypefn} command and its variations are for describing -functions in languages in which you must declare types of variables and -functions, such as C and C++. +functions in C or any other language in which you must declare types +of variables and functions.@refill @table @code @findex deftypefn @@ -10537,7 +9852,7 @@ @example @group -@@deftypefn @{Library Function@} int foobar +@@deftypefn @{Library Function@} int foobar (int @@var@{foo@}, float @@var@{bar@}) @dots{} @@end deftypefn @@ -10603,8 +9918,8 @@ @example @group -@@deftypefn stacks private push - (@@var@{s@}:in out stack; +@@deftypefn stacks private push + (@@var@{s@}:in out stack; @@var@{n@}:in integer) @dots{} @@end deftypefn @@ -10623,8 +9938,8 @@ @code{@@deftypefn} creates an entry in the index of functions for @var{name}.@refill +@findex deftypefun @item @@deftypefun @var{data-type} @var{name} @var{arguments}@dots{} -@findex deftypefun The @code{@@deftypefun} command is the specialized definition command for functions in typed languages. The command is equivalent to @samp{@@deftypefn Function @dots{}}.@refill @@ -10676,16 +9991,7 @@ @code{@@deftypefun} creates an entry in the index of functions for @var{name}.@refill - -@item @@deftypemethod @var{class} @var{data-type} @var{method-name} @var{arguments}@dots{} -@findex deftypefun -The @code{@@deftypemethod} command is the definition command for methods -in object-oriented typed languages, such as C++ and Java. It is similar -to the @code{@@deftypefn} with the addition of the @var{class} parameter -to specify the class containing the method. - -@end table - +@end table @node Typed Variables, Abstract Objects, Typed Functions, Def Cmds in Detail @subsection Variables in Typed Languages @@ -10879,7 +10185,7 @@ @findex defop @item @@defop @var{category} @var{class} @var{name} @var{arguments}@dots{} The @code{@@defop} command is the general definition command for -entities that may resemble methods in object-oriented programming. +entities that may resemble methods in object-oriented programming. These entities take arguments, as functions do, but are associated with particular classes of objects.@refill @@ -10928,8 +10234,8 @@ @code{@@defop} creates an entry, such as `@code{expose} on @code{windows}', in the index of functions.@refill +@findex defmethod @item @@defmethod @var{class} @var{name} @var{arguments}@dots{} -@findex defmethod The @code{@@defmethod} command is the definition command for methods in object-oriented programming. A method is a kind of function that implements an operation for a particular class of objects and its @@ -10969,16 +10275,7 @@ @code{@@defmethod} creates an entry, such as `@code{bar-method} on @code{bar-class}', in the index of functions.@refill - -@item @@deftypemethod @var{class} @var{data-type} @var{name} @var{arguments}@dots{} -@findex defmethod -The @code{@@deftypemethod} command is the definition command for methods -in object-oriented typed languages, such as C++ and Java. It is similar -to the @code{@@defmethod} command with the addition of the -@var{data-type} parameter to specify the return type of the method. - -@end table - +@end table @node Data Types, , Abstract Objects, Def Cmds in Detail @subsection Data Types @@ -11049,8 +10346,9 @@ @code{@@defun} command and it is followed, on the same line, by the parameter list.@refill -Here is a definition from @ref{Calling Functions,,, elisp, The GNU Emacs -Lisp Reference Manual}. +Here is a definition from @cite{The GNU Emacs Lisp Reference Manual}. +(@xref{Calling Functions, , Calling Functions, elisp, The GNU Emacs +Lisp Reference Manual}.) @quotation @defun apply function &rest arguments @@ -11137,8 +10435,8 @@ Ordinary variables and user options are described using a format like that for functions except that variables do not take arguments. - @node Footnotes, Conditionals, Definition Commands, Top +@comment node-name, next, previous, up @chapter Footnotes @cindex Footnotes @findex footnote @@ -11150,59 +10448,39 @@ see @cite{The Chicago Manual of Style}, which is published by the University of Chicago Press.}@refill -@menu -* Footnote Commands:: How to write a footnote in Texinfo. -* Footnote Styles:: Controlling how footnotes appear in Info. -@end menu - -@node Footnote Commands, Footnote Styles, Footnotes, Footnotes -@section Footnote Commands - In Texinfo, footnotes are created with the @code{@@footnote} command. This command is followed immediately by a left brace, then by the text -of the footnote, and then by a terminating right brace. Footnotes may -be of any length (they will be broken across pages if necessary), but -are usually short. The template is: - -@example -ordinary text@@footnote@{@var{text of footnote}@} -@end example - -As shown here, the @code{@@footnote} command should come right after the -text being footnoted, with no intervening space; otherwise, the -formatters the footnote mark might end up starting up a line. +of the footnote, and then by a terminating right brace. The template +is: + +@example +@@footnote@{@var{text}@} +@end example + +Footnotes may be of any length, but are usually short.@refill For example, this clause is followed by a sample footnote@footnote{Here is the sample footnote.}; in the Texinfo source, it looks like this:@refill @example -@dots{}a sample footnote@@footnote@{Here is the sample +@dots{}a sample footnote @@footnote@{Here is the sample footnote.@}; in the Texinfo source@dots{} @end example -@strong{Warning:} Don't use footnotes in the argument of the -@code{@@item} command for a @code{@@table} table. This doesn't work, and -because of limitations of @TeX{}, there is no way to fix it. You must -put the footnote into the body text of the table. - In a printed manual or book, the reference mark for a footnote is a -small, superscripted number; the text of the footnote appears at the -bottom of the page, below a horizontal line.@refill +small, superscripted number; the text of the footnote is written at +the bottom of the page, below a horizontal line.@refill In Info, the reference mark for a footnote is a pair of parentheses with the footnote number between them, like this: @samp{(1)}.@refill - -@node Footnote Styles, , Footnote Commands, Footnotes -@section Footnote Styles - Info has two footnote styles, which determine where the text of the footnote is located:@refill @itemize @bullet @cindex @samp{@r{End}} node footnote style -@item +@item In the `End' node style, all the footnotes for a single node are placed at the end of that node. The footnotes are separated from the rest of the node by a line of dashes with the word @@ -11222,7 +10500,7 @@ @end example @cindex @samp{@r{Separate}} footnote style -@item +@item In the `Separate' node style, all the footnotes for a single node are placed in an automatically constructed node of their own. In this style, a ``footnote reference'' follows @@ -11245,7 +10523,7 @@ @group File: texinfo.info Node: Overview-Footnotes, Up: Overview -(1) Note that the first syllable of "Texinfo" is +(1) Note that the first syllable of "Texinfo" is pronounced like "speck", not "hex". @dots{} @end group @end smallexample @@ -11258,7 +10536,7 @@ Use the @code{@@footnotestyle} command to specify an Info file's footnote style. Write this command at the beginning of a line followed by an argument, either @samp{end} for the end node style or -@samp{separate} for the separate node style. +@samp{separate} for the separate node style. @need 700 For example, @@ -11320,14 +10598,15 @@ @end ignore This chapter contains two footnotes.@refill - -@node Conditionals, Macros, Footnotes, Top +@node Conditionals, Format/Print Hardcopy, Footnotes, Top @comment node-name, next, previous, up @chapter Conditionally Visible Text @cindex Conditionally visible text @cindex Text, conditionally visible @cindex Visibility of conditional text @cindex If text conditionally visible +@findex ifinfo +@findex iftex Sometimes it is good to use different text for a printed manual and its corresponding Info file. In this case, you can use the @@ -11335,23 +10614,21 @@ and which is for the Info file.@refill @menu -* Conditional Commands:: Specifying text for HTML, Info, or @TeX{}. -* Conditional Not Commands:: Specifying text for not HTML, Info, or @TeX{}. -* Raw Formatter Commands:: Using raw @TeX{} or HTML commands. -* set clear value:: Designating which text to format (for - all output formats); and how to set a +* Conditional Commands:: How to specify text for Info or @TeX{}. +* Using Ordinary TeX Commands:: You can use any and all @TeX{} commands. +* set clear value:: How to designate which text to format (for + both Info and @TeX{}); and how to set a flag to a string that you can insert. @end menu -@node Conditional Commands, Conditional Not Commands, Conditionals, Conditionals +@node Conditional Commands, Using Ordinary TeX Commands, Conditionals, Conditionals @ifinfo -@heading Conditional Commands +@heading Using @code{@@ifinfo} and @code{@@iftex} @end ifinfo -@findex ifinfo -@code{@@ifinfo} begins segments of text that should be ignored +@code{@@ifinfo} begins segments of text that should be ignored by @TeX{} when it -typesets the printed manual. The segment of text appears only +typesets the printed manual. The segment of text appears only in the Info file. The @code{@@ifinfo} command should appear on a line by itself; end the Info-only text with a line containing @code{@@end ifinfo} by @@ -11359,20 +10636,19 @@ contained within a region marked by @code{@@ifinfo} and @code{@@end ifinfo}. (@xref{Info Summary and Permissions}.)@refill -@findex iftex -@findex ifhtml The @code{@@iftex} and @code{@@end iftex} commands are similar to the @code{@@ifinfo} and @code{@@end ifinfo} commands, except that they specify text that will appear in the printed manual but not in the Info -file. Likewise for @code{@@ifhtml} and @code{@@end ifhtml}, which -specify text to appear only in HTML output.@refill - +file.@refill + +@need 700 For example, @example @@iftex This text will appear only in the printed manual. @@end iftex + @@ifinfo However, this text will appear only in Info. @@end ifinfo @@ -11380,9 +10656,11 @@ @noindent The preceding example produces the following line: + @iftex This text will appear only in the printed manual. @end iftex + @ifinfo However, this text will appear only in Info. @end ifinfo @@ -11394,103 +10672,65 @@ The @code{@@titlepage} command is a special variant of @code{@@iftex} that is used for making the title and copyright pages of the printed -manual. (@xref{titlepage, , @code{@@titlepage}}.) @refill - - -@node Conditional Not Commands, Raw Formatter Commands, Conditional Commands, Conditionals -@section Conditional Not Commands -@findex ifnothtml -@findex ifnotinfo -@findex ifnottex - -You can specify text to be included in any output format @emph{other} -than some given one with the @code{@@ifnot@dots{}} commands: -@example -@@ifnothtml @dots{} @@end ifnothtml -@@ifnotinfo @dots{} @@end ifnotinfo -@@ifnottex @dots{} @@end ifnottex -@end example -@noindent -(The @code{@@ifnot@dots{}} command and the @code{@@end} command must -actually appear on lines by themselves.) - -If the output file is not being made for the given format, the region is -included. Otherwise, it is ignored. - -The regions delimited by these commands are ordinary Texinfo source as -with @code{@@iftex}, not raw formatter source as with @code{@@tex}. - - -@node Raw Formatter Commands, set clear value, Conditional Not Commands, Conditionals -@section Raw Formatter Commands +manual. (@xref{titlepage, , @code{@@titlepage}}.) @refill + +@node Using Ordinary TeX Commands, set clear value, Conditional Commands, Conditionals +@comment node-name, next, previous, up +@section Using Ordinary @TeX{} Commands @cindex @TeX{} commands, using ordinary -@cindex HTML commands, using ordinary -@cindex Raw formatter commands @cindex Ordinary @TeX{} commands, using -@cindex Ordinary HTML commands, using -@cindex Commands using raw @TeX{} -@cindex Commands using raw HTML -@cindex plain @TeX{} - -Inside a region delineated by @code{@@iftex} and @code{@@end iftex}, you -can embed some raw @TeX{} commands. Info will ignore these commands -since they are only in that part of the file which is seen by @TeX{}. -You can write the @TeX{} commands as you would write them in a normal -@TeX{} file, except that you must replace the @samp{\} used by @TeX{} -with an @samp{@@}. For example, in the @code{@@titlepage} section of a -Texinfo file, you can use the @TeX{} command @code{@@vskip} to format -the copyright page. (The @code{@@titlepage} command causes Info to -ignore the region automatically, as it does with the @code{@@iftex} -command.) - -However, many features of plain @TeX{} will not work, as they are -overridden by Texinfo features. +@cindex Commands using ordinary @TeX{} +@cindex Plain@TeX{} + +Inside a region delineated by @code{@@iftex} and @code{@@end iftex}, +you can embed some Plain@TeX{} commands. Info will ignore these +commands since they are only in that part of the file which is seen by +@TeX{}. You can write the @TeX{} commands as you would write them in +a normal @TeX{} file, except that you must replace the @samp{\} used +by @TeX{} with an @samp{@@}. For example, in the @code{@@titlepage} +section of a Texinfo file, you can use the @TeX{} command +@code{@@vskip} to format the copyright page. (The @code{@@titlepage} +command causes Info to ignore the region automatically, as it does +with the @code{@@iftex} command.)@refill + +However, many features of Plain@TeX{} will not work, as they are +overridden by features of Texinfo. @findex tex -You can enter plain @TeX{} completely, and use @samp{\} in the @TeX{} +You can enter Plain@TeX{} completely, and use @samp{\} in the @TeX{} commands, by delineating a region with the @code{@@tex} and @code{@@end tex} commands. (The @code{@@tex} command also causes Info to ignore the -region, like the @code{@@iftex} command.) The sole exception is that -@code{@@} chracter still introduces a command, so that @code{@@end tex} -can be recognized properly. +region, like the @code{@@iftex} +command.)@refill @cindex Mathematical expressions For example, here is a mathematical expression written in -plain @TeX{}: +Plain@TeX{}:@refill @example @@tex -$$ \chi^2 = \sum_@{i=1@}^N - \left (y_i - (a + b x_i) +$$ \chi^2 = \sum_@{i=1@}^N + \left (y_i - (a + b x_i) \over \sigma_i\right)^2 $$ @@end tex @end example @noindent The output of this example will appear only in a printed manual. If -you are reading this in Info, you will not see the equation that appears -in the printed manual. +you are reading this in Info, you will not see anything after this +paragraph. @iftex In a printed manual, the above expression looks like this: @end iftex @tex -$$ \chi^2 = \sum_{i=1}^N - \left(y_i - (a + b x_i) +$$ \chi^2 = \sum_{i=1}^N + \left(y_i - (a + b x_i) \over \sigma_i\right)^2 $$ @end tex -@findex ifhtml -@findex html -Analogously, you can use @code{@@ifhtml @dots{} @@end ifhtml} to delimit -a region to be included in HTML output only, and @code{@@html @dots{} -@@end ifhtml} for a region of raw HTML (again, except that @code{@@} is -still the escape character, so the @code{@@end} command can be -recognized.) - - -@node set clear value, , Raw Formatter Commands, Conditionals +@node set clear value, , Using Ordinary TeX Commands, Conditionals @comment node-name, next, previous, up @section @code{@@set}, @code{@@clear}, and @code{@@value} @@ -11506,11 +10746,10 @@ @menu * ifset ifclear:: Format a region if a flag is set. -* value:: Replace a flag with a string. +* value:: Replace a flag with a string. * value Example:: An easy way to update edition information. @end menu - @node ifset ifclear, value, set clear value, set clear value @subsection @code{@@ifset} and @code{@@ifclear} @@ -11524,7 +10763,7 @@ @var{flag}; a @dfn{flag} can be any single word. The format for the command looks like this:@refill @findex set - + @example @@set @var{flag} @end example @@ -11544,7 +10783,7 @@ a manual for a `large' and `small' model:@refill @example -You can use this machine to dig up shrubs +You can use this machine to dig up shrubs without hurting them. @@set large @@ -11617,7 +10856,7 @@ If @var{flag} is cleared, tell the Texinfo formatting commands to ignore text up to the following @code{@@end ifset} command.@refill -@item @@ifclear @var{flag} +@item @@ifclear @var{flag} If @var{flag} is set, tell the Texinfo formatting commands to ignore the text up to the following @code{@@end ifclear} command.@refill @@ -11711,7 +10950,7 @@ @subsection @code{@@value} Example You can use the @code{@@value} command to limit the number of places you -need to change when you record an update to a manual. +need to change when you record an update to a manual. Here is how it is done in @cite{The GNU Make Manual}: @need 1000 @@ -11734,9 +10973,9 @@ @example @group -This is Edition @@value@{EDITION@}, +This is Edition @@value@{EDITION@}, last updated @@value@{UPDATED@}, -of @@cite@{The GNU Make Manual@}, +of @@cite@{The GNU Make Manual@}, for @@code@{make@}, Version @@value@{VERSION@}. @end group @end example @@ -11766,7 +11005,7 @@ @example @group -This is Edition @@value@{EDITION@} +This is Edition @@value@{EDITION@} of the @@cite@{GNU Make Manual@}, last updated @@value@{UPDATED@} for @@code@{make@} Version @@value@{VERSION@}. @@ -11779,7 +11018,7 @@ @example @group -This is Edition 0.35 Beta, last updated 14 August 1992, +This is Edition 0.35 Beta, last updated 14 August 1992, of `The GNU Make Manual', for `make', Version 3.63 Beta. @end group @end example @@ -11787,133 +11026,7 @@ When you update the manual, change only the values of the flags; you do not need to rewrite the three sections. - -@node Macros, Format/Print Hardcopy, Conditionals, Top -@chapter Macros: Defining New Texinfo Commands -@cindex Macros -@cindex Defining new Texinfo commands -@cindex New Texinfo commands, defining -@cindex Texinfo commands, defining new -@cindex User-defined Texinfo commands - -A Texinfo @dfn{macro} allows you to define a new Texinfo command as any -sequence of text and/or existing commands (including other macros). The -macro can have any number of @dfn{parameters}---text you supply each -time you use the macro. (This has nothing to do with the -@code{@@defmac} command, which is for documenting macros in the subject -of the manual; @pxref{Def Cmd Template}.) - -@menu -* Defining Macros:: Both defining and undefining new commands. -* Invoking Macros:: Using a macro, once you've defined it. -@end menu - - -@node Defining Macros, Invoking Macros, Macros, Macros -@section Defining Macros -@cindex Defining macros -@cindex Macro definitions - -@findex macro -You use the Texinfo @code{@@macro} command to define a macro. For example: - -@example -@@macro @var{macro-name}@{@var{param1}, @var{param2}, @dots{}@} -@var{text} @dots{} \@var{param1}\ @dots{} -@@end macro -@end example - -The @dfn{parameters} @var{param1}, @var{param2}, @dots{} correspond to -arguments supplied when the macro is subsequently used in the document -(see the next section). - -If a macro needs no parameters, you can define it either with an empty -list (@samp{@@macro foo @{@}}) or with no braces at all (@samp{@@macro -foo}). - -@cindex Body of a macro -@cindex Mutually recursive macros -@cindex Recursion, mutual -The definition or @dfn{body} of the macro can contain any Texinfo -commands, including previously-defined macros. (It is not possible to -have mutually recursive Texinfo macros.) In the body, instances of a -parameter name surrounded by backslashes, as in @samp{\@var{param1}\} in -the example above, are replaced by the corresponding argument from the -macro invocation. - -@findex unmacro -@cindex Macros, undefining -@cindex Undefining macros -You can undefine a macro @var{foo} with @code{@@unmacro @var{foo}}. -It is not an error to undefine a macro that is already undefined. -For example: - -@example -@@unmacro foo -@end example - - -@node Invoking Macros, , Defining Macros, Macros -@section Invoking Macros -@cindex Invoking macros -@cindex Macro invocation - -After a macro is defined (see the previous section), you can use -(@dfn{invoke}) it in your document like this: - -@example -@@@var{macro-name} @{@var{arg1}, @var{arg2}, @dots{}@} -@end example - -@noindent and the result will be just as if you typed the body of -@var{macro-name} at that spot. For example: - -@example -@@macro foo @{p, q@} -Together: \p\ & \q\. -@@end macro -@@foo@{a, b@} -@end example - -@noindent produces: - -@display -Together: a & b. -@end display - -@cindex Backslash, and macros -Thus, the arguments and parameters are separated by commas and delimited -by braces; any whitespace after (but not before) a comma is ignored. To -insert a comma, brace, or backslash in an argument, prepend a backslash, -as in - -@example -@@@var{macro-name} @{\\\@{\@}\,@} -@end example - -@noindent -which will pass the (almost certainly error-producing) argument -@samp{\@{@},} to @var{macro-name}. - -If the macro is defined to take a single argument, and is invoked -without any braces, the entire rest of the line after the macro name is -supplied as the argument. For example: - -@example -@@macro bar @{p@} -Twice: \p\, \p\. -@@end macro -@@bar aah -@end example - -@noindent produces: - -@display -Twice: aah, aah. -@end display - - -@node Format/Print Hardcopy, Create an Info File, Macros, Top +@node Format/Print Hardcopy, Create an Info File, Conditionals, Top @comment node-name, next, previous, up @chapter Format and Print Hardcopy @cindex Format and print hardcopy @@ -11922,7 +11035,7 @@ @cindex Sorting indices @cindex Indices, sorting @cindex @TeX{} index sorting -@pindex texindex +@findex texindex There are three major shell commands for making a printed manual from a Texinfo file: one for converting the Texinfo file into a file that will be @@ -11961,8 +11074,8 @@ The typesetting program called @TeX{} is used for formatting a Texinfo file. @TeX{} is a very powerful typesetting program and, if used right, -does an exceptionally good job. (@xref{Obtaining TeX, , How to Obtain -@TeX{}}, for information on how to obtain @TeX{}.) +does an exceptionally good job. @xref{Obtaining TeX, , How to Obtain +@TeX{}}, for information on how to obtain @TeX{}.@refill The @code{makeinfo}, @code{texinfo-format-region}, and @code{texinfo-format-buffer} commands read the very same @@-commands @@ -11977,43 +11090,45 @@ @cindex DVI file Format the Texinfo file with the shell command @code{tex} followed by -the name of the Texinfo file. For example: - -@example -tex foo.texi -@end example - -@noindent @TeX{} will produce a @dfn{DVI file} as well as several auxiliary -files containing information for indices, cross references, etc. The -DVI file (for @dfn{DeVice Independent} file) can be printed on virtually -any printe (see the following sections). - -@pindex texindex +the name of the Texinfo file. This command produces a formatted +@sc{dvi} file as well as several auxiliary files containing indices, +cross references, etc. The @sc{dvi} file (for @dfn{DeVice Independent} +file) can be printed on a wide variety of printers.@refill + The @code{tex} formatting command itself does not sort the indices; it -writes an output file of unsorted index data. (The @code{texi2dvi} -command automatically generates indices; see @ref{Format with texi2dvi,, -Format using @code{texi2dvi}}.) To generate a printed index after -running the @code{tex} command, you first need a sorted index to work -from. The @code{texindex} command sorts indices. (The source file -@file{texindex.c} comes as part of the standard Texinfo distribution, -among other places.)@refill - -@cindex Names of index files +writes an output file of unsorted index data. This is a misfeature of +@TeX{}. (The @code{texi2dvi} command automatically generates indices; +see @ref{Format with texi2dvi, , Format using @code{texi2dvi}}.) To +generate a printed index after running the @code{tex} command, you first +need a sorted index to work from. The @code{texindex} command sorts +indices. (The source file @file{texindex.c} comes as part of the +standard GNU distribution and is usually installed when Emacs is +installed.)@refill +@findex texindex +@ignore +Usage: texindex [-k] [-T tempdir] infile [-o outfile] ... + +Each infile arg can optionally be followed by a `-o outfile' arg; +for each infile that is not followed by a -o arg, the infile name with +`s' (for `sorted') appended is used for the outfile. + +-T dir is the directory to put temp files in, instead of /tmp. +-k means `keep tempfiles', for debugging. +@end ignore + The @code{tex} formatting command outputs unsorted index files under -names that obey a standard convention: the name of your main input file -with any @samp{.tex} (or similar, @pxref{tex invocation,,, web2c, -Web2c}) extension removed, followed by the two letter names of indices. -For example, the raw index output files for the input file -@file{foo.texinfo} would be @file{foo.cp}, @file{foo.vr}, @file{foo.fn}, -@file{foo.tp}, @file{foo.pg} and @file{foo.ky}. Those are exactly the -arguments to give to @code{texindex}.@refill +names that obey a standard convention. These names are the name of +your main input file to the @code{tex} formatting command, with +everything after the first period thrown away, and the two letter +names of indices added at the end. For example, the raw index output +files for the input file @file{foo.texinfo} would be @file{foo.cp}, +@file{foo.vr}, @file{foo.fn}, @file{foo.tp}, @file{foo.pg} and +@file{foo.ky}. Those are exactly the arguments to give to +@code{texindex}.@refill @need 1000 -@cindex Wildcards -@cindex Globbing -Instead of specifying all the unsorted index file names explicitly, you -can use @samp{??} as shell wildcards and give the command in this -form:@refill +Or else, you can use @samp{??} as ``wild-cards'' and give the command in +this form:@refill @example texindex foo.?? @@ -12029,86 +11144,84 @@ For each file specified, @code{texindex} generates a sorted index file whose name is made by appending @samp{s} to the input file name. The -@code{@@printindex} command knows to look for a file of that name -(@pxref{Printing Indices & Menus}). @code{texindex} does not alter the -raw index output file.@refill +@code{@@printindex} command knows to look for a file of that name. +@code{texindex} does not alter the raw index output file.@refill After you have sorted the indices, you need to rerun the @code{tex} -formatting command on the Texinfo file. This regenerates the DVI file, -this time with up-to-date index entries. - -Finally, you may need to run @code{tex} one more time, to get the page -numbers in the cross-references correct. - -To summarize, this is a four step process: - +formatting command on the Texinfo file. This regenerates a formatted +@sc{dvi} file with up-to-date index entries.@footnote{If you use more +than one index and have cross references to an index other than the +first, you must run @code{tex} @emph{three times} to get correct output: +once to generate raw index data; again (after @code{texindex}) to output +the text of the indices and determine their true page numbers; and a +third time to output correct page numbers in cross references to them. +However, cross references to indices are rare.}@refill + +To summarize, this is a three step process: + @enumerate -@item -Run @code{tex} on your Texinfo file. This generates a DVI file (with -undefined cross-references and no indices), and the raw index files -(with two letter extensions). - -@item -Run @code{texindex} on the raw index files. This creates the -corresponding sorted index files (with three letter extensions). - -@item -Run @code{tex} again on your Texinfo file. This regenerates the DVI -file, this time with indices and defined cross-references, but with page -numbers for the cross-references from last time, generally incorrect. - -@item -Run @code{tex} one last time. This time the correct page numbers are -written for the cross-references. +@item +Run the @code{tex} formatting command on the Texinfo file. This +generates the formatted @sc{dvi} file as well as the raw index files +with two letter extensions.@refill + +@item +Run the shell command @code{texindex} on the raw index files to sort +them. This creates the corresponding sorted index files.@refill + +@item +Rerun the @code{tex} formatting command on the Texinfo file. This +regenerates a formatted @sc{dvi} file with the index entries in the +correct order. This second run also corrects the page numbers for +the cross references. (The tables of contents are always correct.)@refill @end enumerate -@pindex texi2dvi -Alternatively, it's a one-step process: run @code{texi2dvi}. - -You need not run @code{texindex} each time after you run @code{tex}. If -you do not, on the next run, the @code{tex} formatting command will use -whatever sorted index files happen to exist from the previous use of -@code{texindex}. This is usually ok while you are -debugging.@refill +You need not run @code{texindex} each time after you run the +@code{tex} formatting. If you do not, on the next run, the @code{tex} +formatting command will use whatever sorted index files happen to +exist from the previous use of @code{texindex}. This is usually +@sc{ok} while you are debugging.@refill @node Format with texi2dvi, Print with lpr, Format with tex/texindex, Format/Print Hardcopy @comment node-name, next, previous, up @section Format using @code{texi2dvi} -@pindex texi2dvi @r{(shell script)} +@findex texi2dvi @r{(shell script)} The @code{texi2dvi} command is a shell script that automatically runs -both @code{tex} and @code{texindex} as many times as necessary to -produce a DVI file with up-to-date, sorted indices. It simplifies the +both @code{tex} and @code{texindex} as needed to produce a @sc{dvi} file +with up-to-date, sorted indices. It simplifies the @code{tex}---@code{texindex}---@code{tex} sequence described in the previous section. @need 1000 -The syntax for @code{texi2dvi} is like this (where @samp{prompt$} is the +The syntax for @code{texi2dvi} is like this (where @samp{%} is the shell prompt):@refill @example -prompt$ @kbd{texi2dvi @var{filename}@dots{}} +% texi2dvi @var{filename}@dots{} @end example @node Print with lpr, Within Emacs, Format with texi2dvi, Format/Print Hardcopy @comment node-name, next, previous, up @section Shell Print Using @code{lpr -d} -@pindex lpr @r{(DVI print command)} - -The precise command to print a DVI file depends on your system -installation, but @samp{lpr -d} is common. The command may require the -DVI file name without any extension or with a @samp{.dvi} -extension. (If it is @samp{lpr}, you must include the @samp{.dvi}.) - -The following commands, for example, will (probably) suffice to sort the -indices, format, and print the @cite{Bison Manual}: - -@example -@group -tex bison.texinfo -texindex bison.?? -tex bison.texinfo -lpr -d bison.dvi +@findex lpr @r{(@sc{dvi} print command)} + +You can print a @sc{dvi} file with the @sc{dvi} print command. The +precise printing command to use depends on your system; @samp{lpr -d} is +common. The @sc{dvi} print command may require a file name without any +extension or with a @samp{.dvi} extension.@refill + +@need 1200 +The following commands, for example, sort the indices, format, and +print the @cite{Bison Manual} (where @samp{%} is the shell +prompt):@refill + +@example +@group +% tex bison.texinfo +% texindex bison.?? +% tex bison.texinfo +% lpr -d bison.dvi @end group @end example @@ -12121,14 +11234,14 @@ @example @group -texi2dvi bison.texinfo -lpr -d bison.dvi +% texi2dvi bison.texinfo +% lpr -d bison.dvi @end group @end example @node Within Emacs, Texinfo Mode Printing, Print with lpr, Format/Print Hardcopy @comment node-name, next, previous, up -@section From an Emacs Shell +@section From an Emacs Shell @dots{} @cindex Print, format from Emacs shell @cindex Format, print from Emacs shell @cindex Shell, format, print from @@ -12146,12 +11259,13 @@ You can also use @code{texi2dvi} from an Emacs shell. For example, here is how to use @code{texi2dvi} to format and print @cite{Using and -Porting GNU CC} from a shell within Emacs: - -@example -@group -texi2dvi gcc.texinfo -lpr -d gcc.dvi +Porting GNU CC} from a shell within Emacs (where @samp{%} is the shell +prompt):@refill + +@example +@group +% texi2dvi gcc.texinfo +% lpr -d gcc.dvi @end group @end example @ifinfo @@ -12177,7 +11291,7 @@ @itemx M-x texinfo-tex-buffer Run @code{texi2dvi} on the current buffer.@refill -@item C-c C-t C-r +@item C-c C-t C-r @itemx M-x texinfo-tex-region Run @TeX{} on the current region.@refill @@ -12188,7 +11302,7 @@ @item C-c C-t C-p @itemx M-x texinfo-tex-print -Print a DVI file that was made with @code{texinfo-tex-region} or +Print a @sc{dvi} file that was made with @code{texinfo-tex-region} or @code{texinfo-tex-buffer}.@refill @item C-c C-t C-q @@ -12226,7 +11340,7 @@ @example @group C-c C-t C-b @r{Run @code{texi2dvi} on the buffer.} -C-c C-t C-p @r{Print the DVI file.} +C-c C-t C-p @r{Print the @sc{dvi} file.} C-c C-t C-q @r{Display the printer queue.} @end group @end example @@ -12234,7 +11348,7 @@ The Texinfo mode @TeX{} formatting commands start a subshell in Emacs called the @file{*tex-shell*}. The @code{texinfo-tex-command}, @code{texinfo-texindex-command}, and @code{tex-dvi-print-command} -commands are all run in this shell. +commands are all run in this shell. You can watch the commands operate in the @samp{*tex-shell*} buffer, and you can switch to and from and use the @samp{*tex-shell*} buffer @@ -12285,9 +11399,9 @@ @example @group -Local Variables: -compile-command: "texi2dvi gdb.texinfo" -End: +@@c Local Variables: +@@c compile-command: "texi2dvi gdb.texinfo" +@@c End: @end group @end example @@ -12295,45 +11409,47 @@ This technique is most often used by programmers who also compile programs this way; see @ref{Compilation, , , emacs, The GNU Emacs Manual}.@refill - @node Requirements Summary, Preparing for TeX, Compile-Command, Format/Print Hardcopy @comment node-name, next, previous, up @section @TeX{} Formatting Requirements Summary -@cindex Requirements for formatting -@cindex Minimal requirements for formatting +@cindex Requirements for formatting @cindex Formatting requirements Every Texinfo file that is to be input to @TeX{} must begin with a -@code{\input} command and must contain an @code{@@setfilename} command: +@code{\input} command and contain an @code{@@settitle} command:@refill @example \input texinfo -@@setfilename @var{arg-not-used-by-@TeX{}} +@@settitle @var{name-of-manual} @end example @noindent The first command instructs @TeX{} to load the macros it needs to -process a Texinfo file and the second command opens auxiliary files. - -Every Texinfo file must end with a line that terminates @TeX{}'s -processing and forces out unfinished pages: +process a Texinfo file and the second command specifies the title of +printed manual.@refill + +@need 1000 +Every Texinfo file must end with a line that terminates @TeX{} +processing and forces out unfinished pages:@refill @example @@bye @end example -Strictly speaking, these lines are all a Texinfo file needs to be -processed successfully by @TeX{}. - -Usually, however, the beginning includes an @code{@@settitle} command to -define the title of the printed manual, an @code{@@setchapternewpage} +Strictly speaking, these three lines are all a Texinfo file needs for +@TeX{}, besides the body. (The @code{@@setfilename} line is the only +line that a Texinfo file needs for Info formatting.)@refill + +Usually, the file's first line contains an @samp{@@c -*-texinfo-*-} +comment that causes Emacs to switch to Texinfo mode when you edit the +file. In addition, the beginning usually includes an +@code{@@setfilename} for Info formatting, an @code{@@setchapternewpage} command, a title page, a copyright page, and permissions. Besides an @code{@@bye}, the end of a file usually includes indices and a table of -contents. (And of course most manuals contain a body of text as well.) +contents.@refill @iftex For more information, see -@ref{settitle, , @code{@@settitle}}, @ref{setchapternewpage, , @code{@@setchapternewpage}}, @ref{Headings, ,Page Headings}, @ref{Titlepage & Copyright Page}, @@ -12343,7 +11459,6 @@ @noindent @ifinfo For more information, see@* -@ref{settitle, , @code{@@settitle}},@* @ref{setchapternewpage, , @code{@@setchapternewpage}},@* @ref{Headings, ,Page Headings},@* @ref{Titlepage & Copyright Page},@* @@ -12351,7 +11466,6 @@ @ref{Contents}. @end ifinfo - @node Preparing for TeX, Overfull hboxes, Requirements Summary, Format/Print Hardcopy @comment node-name, next, previous, up @section Preparing to Use @TeX{} @@ -12363,60 +11477,41 @@ @cindex @b{.cshrc} initialization file @cindex Initialization file for @TeX{} input -@TeX{} needs to know where to find the @file{texinfo.tex} file that you -have told it to input with the @samp{\input texinfo} command at the -beginning of the first line. The @file{texinfo.tex} file tells @TeX{} -how to handle @@-commands; it is included in all standard GNU -distributions. - -@pindex texinfo.tex@r{, installing} -Usually, the @file{texinfo.tex} file is put under the default directory -that contains @TeX{} macros -(@file{/usr/local/share/texmf/tex/texinfo/texinfo.tex} by default) when -GNU Emacs or other GNU software is installed. In this case, @TeX{} will +@TeX{} needs to know where to find the @file{texinfo.tex} file +that you have told it to input with the @samp{\input texinfo} command +at the beginning of the first line. The @file{texinfo.tex} file tells +@TeX{} how to handle @@-commands. (@file{texinfo.tex} is +included in the standard GNU distributions.)@refill + +Usually, the @file{texinfo.tex} file is put in the default directory +that contains @TeX{} macros (the @file{/usr/lib/tex/macros} +directory) when GNU Emacs or other GNU software is installed. +In this case, @TeX{} will find the file and you do not need to do anything special. -Alternatively, you can put @file{texinfo.tex} in the current directory -when you run @TeX{}, and @TeX{} will find it there. - -@pindex epsf.tex@r{, installing} -Also, you should install @file{epsf.tex} in the same place as -@file{texinfo.tex}, if it is not already installed from another -distribution. This file is needed to support the @code{@@image} command -(@pxref{Images}). - -@pindex texinfo.cnf @r{installation} -@cindex Customizing of @TeX{} for Texinfo -@cindex Site-wide Texinfo configuration file -Optionally, you may create an additional @file{texinfo.cnf}, and install -it as well. This file is read by @TeX{} at the @code{@@setfilename} -command (@pxref{setfilename,, @code{@@setfilename}}). You can put any -commands you like there according to local site-wide conventions, and -they will be read by @TeX{} when processing any Texinfo document. For -example, if @file{texinfo.cnf} contains the a single line -@samp{@@afourpaper} (@pxref{A4 Paper}), then all Texinfo documents will -be processed with that page size in effect. If you have nothing to put -in @file{texinfo.cnf}, you do not need to create it. - -@vindex TEXINPUTS -If neither of the above locations for these system files suffice for -you, you can specify the directories explicitly. For -@file{texinfo.tex}, you can do this by writing the complete path for the -file after the @code{\input} command. Another way, that works for both -@file{texinfo.tex} and @file{texinfo.cnf} (and any other file @TeX{} -might read), is to set the @code{TEXINPUTS} environment variable in your -@file{.cshrc} or @file{.profile} file. - -Which you use of @file{.cshrc} or @file{.profile} depends on -whether you use a Bourne shell-compatible (@code{sh}, @code{bash}, -@code{ksh}, @dots{}) or C shell-compatible (@code{csh}, @code{tcsh}) -command interpreter. The latter read the @file{.cshrc} file for -initialization information, and the former read @file{.profile}. - +Alternatively, you can put @file{texinfo.tex} in the directory in +which the Texinfo source file is located, and @TeX{} will find it +there.@refill + +However, you may want to specify the location of the @code{\input} file +yourself. One way to do this is to write the complete path for the file +after the @code{\input} command. Another way is to set the +@code{TEXINPUTS} environment variable in your @file{.cshrc} or +@file{.profile} file. The @code{TEXINPUTS} environment variable will tell +@TeX{} where to find the @file{texinfo.tex} file and any other file that +you might want @TeX{} to use.@refill + +Whether you use a @file{.cshrc} or @file{.profile} file depends on +whether you use @code{csh}, @code{sh}, or @code{bash} for your shell +command interpreter. When you use @code{csh}, it looks to the +@file{.cshrc} file for initialization information, and when you use +@code{sh} or @code{bash}, it looks to the @file{.profile} file.@refill + +@need 1000 In a @file{.cshrc} file, you could use the following @code{csh} command -sequence: - -@example -setenv TEXINPUTS .:/home/me/mylib:/usr/lib/tex/macros +sequence:@refill + +@example +setenv TEXINPUTS .:/usr/me/mylib:/usr/lib/tex/macros @end example @need 1000 @@ -12425,7 +11520,7 @@ @example @group -TEXINPUTS=.:/home/me/mylib:/usr/lib/tex/macros +TEXINPUTS=.:/usr/me/mylib:/usr/lib/tex/macros export TEXINPUTS @end group @end example @@ -12433,8 +11528,7 @@ @noindent This would cause @TeX{} to look for @file{\input} file first in the current directory, indicated by the @samp{.}, then in a hypothetical user's -@file{me/mylib} directory, and finally in a system directory. - +@file{me/mylib} directory, and finally in the system library.@refill @node Overfull hboxes, smallbook, Preparing for TeX, Format/Print Hardcopy @comment node-name, next, previous, up @@ -12459,7 +11553,7 @@ @TeX{} also provides the line number in the Texinfo source file and the text of the offending line, which is marked at all the places that -@TeX{} knows how to hyphenate words. +@TeX{} knows how to hyphenate words. @xref{Debugging with TeX, , Catching Errors with @TeX{} Formatting}, for more information about typesetting errors.@refill @@ -12471,7 +11565,7 @@ @cindex Black rectangle in hardcopy @cindex Rectangle, ugly, black in hardcopy However, unless told otherwise, @TeX{} will print a large, ugly, black -rectangle beside the line that contains the overfull hbox. This is so +rectangle beside the line that contains the overful hbox. This is so you will notice the location of the problem if you are correcting a draft.@refill @@ -12521,13 +11615,6 @@ @code{@@smalllisp}}, for information about commands that make it easier to produce examples for a smaller manual.@refill -Alternatively, to avoid embedding this physical paper size in your -document, use @code{texi2dvi} to format your document (@pxref{Format -with texi2dvi}), and supply @samp{-t @@smallbook} as an argument. Then -other people do not have to change the document source file to format it -differently. - - @node A4 Paper, Cropmarks and Magnification, smallbook, Format/Print Hardcopy @comment node-name, next, previous, up @section Printing on A4 Paper @@ -12557,24 +11644,11 @@ @end group @end example -Alternatively, to avoid embedding this physical paper size in your -document, use @code{texi2dvi} to format your document (@pxref{Format -with texi2dvi}), and supply @samp{-t @@afourpaper} as an argument. Then -other people do not have to change the document source file to format it -differently. - -@pindex texinfo.cnf -Another alternative: put the @code{@@afourpaper} command in the file -@file{texinfo.cnf} that @TeX{} will read. (No need for @code{@@iftex} -there.) This will automatically typeset all the Texinfo documents at -your site with that paper size in effect. - - @node Cropmarks and Magnification, , A4 Paper, Format/Print Hardcopy @comment node-name, next, previous, up @section Cropmarks and Magnification -@findex cropmarks +@findex cropmarks @cindex Cropmarks for printing @cindex Printing cropmarks You can attempt to direct @TeX{} to print cropmarks at the corners of @@ -12607,9 +11681,10 @@ usual with the @code{\mag} @TeX{} command. Everything that is typeset is scaled proportionally larger or smaller. (@code{\mag} stands for ``magnification''.) This is @emph{not} a Texinfo @@-command, but is a -plain @TeX{} command that is prefixed with a backslash. You have to +Plain@TeX{} command that is prefixed with a backslash. You have to write this command between @code{@@tex} and @code{@@end tex} -(@pxref{Raw Formatter Commands}). +(@pxref{Using Ordinary TeX Commands, , Using Ordinary @TeX{} +Commands}).@refill Follow the @code{\mag} command with an @samp{=} and then a number that is 1000 times the magnification you desire. For example, to print pages @@ -12641,8 +11716,8 @@ file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are GNU Emacs functions that do the same.@refill -A Texinfo file must contain an @code{@@setfilename} line near its -beginning, otherwise the Info formatting commands will fail. +A Texinfo file must possess an @code{@@setfilename} line near its +beginning, otherwise the Info formatting commands will fail.@refill For information on installing the Info file in the Info system, see @ref{Install an Info File}.@refill @@ -12654,10 +11729,10 @@ * Pointer Validation:: How to check that pointers point somewhere. * makeinfo in Emacs:: How to run @code{makeinfo} from Emacs. * texinfo-format commands:: Two Info formatting commands written - in Emacs Lisp are an alternative + in Emacs Lisp are an alternative to @code{makeinfo}. * Batch Formatting:: How to format for Info in Emacs Batch mode. -* Tag and Split Files:: How tagged and split files help Info +* Tag and Split Files:: How tagged and split files help Info to run better. @end menu @@ -12686,14 +11761,15 @@ To create an Info file from a Texinfo file, type @code{makeinfo} followed by the name of the Texinfo file. Thus, to create the Info -file for Bison, type the following to the shell: +file for Bison, type the following at the shell prompt (where @samp{%} is the prompt):@refill @example -makeinfo bison.texinfo -@end example - -(You can run a shell inside Emacs by typing @kbd{M-x shell}.)@refill +% makeinfo bison.texinfo +@end example + +(You can run a shell inside Emacs by typing @kbd{M-x +shell}.)@refill @ifinfo Sometimes you will want to specify options. For example, if you wish @@ -12701,13 +11777,12 @@ type:@refill @example -makeinfo --version +% makeinfo --version @end example @xref{makeinfo options}, for more information. @end ifinfo - @node makeinfo options, Pointer Validation, Invoking makeinfo, Create an Info File @comment node-name, next, previous, up @section Options for @code{makeinfo} @@ -12717,169 +11792,166 @@ The @code{makeinfo} command takes a number of options. Most often, options are used to set the value of the fill column and specify the footnote style. Each command line option is a word preceded by -@samp{--} or a letter preceded by @samp{-}. You can use abbreviations -for the long option names as long as they are unique.@refill - -For example, you could use the following shell command to create an Info +@samp{--}@footnote{@samp{--} has replaced @samp{+}, the old introductory +character, to maintain POSIX.2 compatibility without losing long-named +options.} or a letter preceded by @samp{-}. You can use abbreviations +for the option names as long as they are unique.@refill + +For example, you could use the following command to create an Info file for @file{bison.texinfo} in which each line is filled to only 68 -columns:@refill - -@example -makeinfo --fill-column=68 bison.texinfo +columns (where @samp{%} is the prompt):@refill + +@example +% makeinfo --fill-column=68 bison.texinfo @end example You can write two or more options in sequence, like this:@refill @example -makeinfo --no-split --fill-column=70 @dots{} +% makeinfo --no-split --fill-column=70 @dots{} @end example @noindent This would keep the Info file together as one possibly very long file and would also set the fill column to 70.@refill -The options are: - +@iftex +If you wish to discover which version of @code{makeinfo} +you are using, type:@refill + +@example +% makeinfo --version +@end example +@end iftex + +The options are:@refill + +@need 100 @table @code - @item -D @var{var} -@opindex -D @var{var} -Cause the variable @var{var} to be defined. This is equivalent to -@code{@@set @var{var}} in the Texinfo file (@pxref{set clear value}). - -@item --error-limit=@var{limit} -@opindex --error-limit=@var{limit} -Set the maximum number of errors that @code{makeinfo} will report -before exiting (on the assumption that continuing would be useless); -default 100. +Cause @var{var} to be defined. This is equivalent to +@code{@@set @var{var}} in the Texinfo file. @need 150 -@item --fill-column=@var{width} -@opindex --fill-column=@var{width} +@item --error-limit @var{limit} +Set the maximum number of errors that @code{makeinfo} will report +before exiting (on the assumption that continuing would be useless). +The default number of errors that can be reported before +@code{makeinfo} gives up is 100.@refill + +@need 150 +@item --fill-column @var{width} Specify the maximum number of columns in a line; this is the right-hand edge of a line. Paragraphs that are filled will be filled to this width. (Filling is the process of breaking up and connecting lines so that lines are the same length as or shorter than the number specified as the fill column. Lines are broken between words.) The default value -is 72. - -@item --footnote-style=@var{style} -@opindex --footnote-style=@var{style} +for @code{fill-column} is 72. +@refill + +@item --footnote-style @var{style} Set the footnote style to @var{style}, either @samp{end} for the end -node style (the default) or @samp{separate} for the separate node style. -The value set by this option overrides the value set in a Texinfo file -by an @code{@@footnotestyle} command (@pxref{Footnotes}). When the -footnote style is @samp{separate}, @code{makeinfo} makes a new node -containing the footnotes found in the current node. When the footnote -style is @samp{end}, @code{makeinfo} places the footnote references at -the end of the current node. - -@item --force -@opindex --force -Ordinarily, if the input file has errors, the output files are not -created. With this option, they are preserved. - -@item --help -@opindex --help -Print a usage message listing all available options, then exit successfully. - +node style or @samp{separate} for the separate node style. The value +set by this option overrides the value set in a Texinfo file by an +@code{@@footnotestyle} command. When the footnote style is +@samp{separate}, @code{makeinfo} makes a new node containing the +footnotes found in the current node. When the footnote style is +@samp{end}, @code{makeinfo} places the footnote references at the end +of the current node.@refill + +@need 150 @item -I @var{dir} -@opindex -I @var{dir} Add @code{dir} to the directory search list for finding files that are included using the @code{@@include} command. By default, @code{makeinfo} searches only the current directory. +@need 150 @item --no-headers -@opindex --no-headers Do not include menus or node lines in the output. This results in an @sc{ascii} file that you cannot read in Info since it does not contain -the requisite nodes or menus. It is primarily useful to extract certain -pieces of a manual into separate files to be included in a distribution, -such as @file{INSTALL} files. - +the requisite nodes or menus; but you can print such a file in a +single, typewriter-like font and produce acceptable output. + +@need 150 @item --no-split -@opindex --no-split -Suppress the splitting stage of @code{makeinfo}. By default, large +Suppress the splitting stage of @code{makeinfo}. Normally, large output files (where the size is greater than 70k bytes) are split into -smaller subfiles, each one approximately 50k bytes. - +smaller subfiles, each one approximately 50k bytes. If you specify +@samp{--no-split}, @code{makeinfo} will not split up the output +file.@refill + +@need 100 @item --no-pointer-validate -@itemx --no-validate -@opindex --no-pointer-validate -@opindex --no-validate +@item --no-validate Suppress the pointer-validation phase of @code{makeinfo}. Normally, after a Texinfo file is processed, some consistency checks are made to ensure that cross references can be resolved, etc. @xref{Pointer Validation}.@refill +@need 150 @item --no-warn -@opindex --no-warn -Suppress warning messages (but @emph{not} error messages). You might +Suppress the output of warning messages. This does @emph{not} +suppress the output of error messages, only warnings. 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. +exist.@refill @item --no-number-footnotes -@opindex --no-number-footnotes Suppress automatic footnote numbering. By default, @code{makeinfo} numbers each footnote sequentially in a single node, resetting the current footnote number to 1 at the start of each node. -@item --output=@var{file} +@need 150 +@item --output @var{file} @itemx -o @var{file} -@opindex --output=@var{file} -@opindex -o @var{file} Specify that the output should be directed to @var{file} and not to the -file name specified in the @code{@@setfilename} command found in the -Texinfo source (@pxref{setfilename}). If @var{file} is @samp{-}, output -goes to standard output and @samp{--no-split} is implied. - -@item -P @var{dir} -@opindex -P @var{dir} -Prepend @code{dir} to the directory search list for @code{@@include}. -See @samp{-I} for more details. - -@item --paragraph-indent=@var{indent} -@opindex --paragraph-indent=@var{indent} +file name specified in the @code{@@setfilename} command found in the Texinfo +source. @var{file} can be the special token @samp{-}, which specifies +standard output. + +@need 150 +@item --paragraph-indent @var{indent} Set the paragraph indentation style to @var{indent}. The value set by this option overrides the value set in a Texinfo file by an -@code{@@paragraphindent} command (@pxref{paragraphindent}). The value -of @var{indent} is interpreted as follows: - -@table @asis -@item @samp{asis} -Preserve any existing indentation at the starts of paragraphs. - -@item @samp{0} or @samp{none} -Delete any existing indentation. - -@item @var{num} -Indent each paragraph by that number of spaces. -@end table - -@item --reference-limit=@var{limit} -@opindex --reference-limit=@var{limit} +@code{@@paragraphindent} command. The value of @var{indent} is +interpreted as follows:@refill + +@itemize @bullet +@item +If the value of @var{indent} is @samp{asis}, do not change the +existing indentation at the starts of paragraphs.@refill + +@item +If the value of @var{indent} is zero, delete any existing +indentation.@refill + +@item +If the value of @var{indent} is greater than zero, indent each +paragraph by that number of spaces.@refill +@end itemize + +@need 100 +@item --reference-limit @var{limit} Set the value of the number of references to a node that @code{makeinfo} will make without reporting a warning. If a node has more than this number of references in it, @code{makeinfo} will make the -references but also report a warning. The default is 1000. - +references but also report a warning.@refill + +@need 150 @item -U @var{var} -Cause @var{var} to be undefined. This is equivalent to -@code{@@clear @var{var}} in the Texinfo file (@pxref{set clear value}). - +Cause @var{var} to be undefined. This is equivalent to +@code{@@clear @var{var}} in the Texinfo file. + +@need 100 @item --verbose -@opindex --verbose Cause @code{makeinfo} to display messages saying what it is doing. Normally, @code{makeinfo} only outputs messages if there are errors or -warnings. - +warnings.@refill + +@need 100 @item --version -@opindex --version -Print the version number, then exit successfully. - -@end table - +Report the version number of this copy of @code{makeinfo}.@refill +@end table @node Pointer Validation, makeinfo in Emacs, makeinfo options, Create an Info File @section Pointer Validation @@ -12898,7 +11970,7 @@ @file{(dir)}, then the referenced node must exist.@refill @item -In every node, if the `Previous' node is different from the `Up' node, +In every node, if the `Previous' node is different from the `Up' node, then the `Previous' node must also be pointed to by a `Next' node.@refill @item @@ -12943,7 +12015,7 @@ When you invoke either @code{makeinfo-region} or @code{makeinfo-buffer}, Emacs prompts for a file name, offering the name of the visited file as the default. You can edit the default -file name in the minibuffer if you wish, before pressing @key{RET} to +file name in the minibuffer if you wish, before typing @key{RET} to start the @code{makeinfo} process.@refill The Emacs @code{makeinfo-region} and @code{makeinfo-buffer} commands @@ -12993,8 +12065,8 @@ @example @group -(setq makeinfo-options - "--paragraph-indent=0 --no-split +(setq makeinfo-options + "--paragraph-indent=0 --no-split --fill-column=70 --verbose") @end group @end example @@ -13064,11 +12136,11 @@ including a shell inside of Emacs. (@xref{Command Switches, , Command Line Switches and Arguments, emacs, The GNU Emacs Manual}.)@refill -Here is a shell command to format all the files that end in -@file{.texinfo} in the current directory: - -@example -emacs -batch -funcall batch-texinfo-format *.texinfo +Here is the command to format all the files that end in @file{.texinfo} +in the current directory (where @samp{%} is the shell prompt):@refill + +@example +% emacs -batch -funcall batch-texinfo-format *.texinfo @end example @noindent @@ -13174,7 +12246,6 @@ validate the structure of the nodes, see @ref{Using Info-validate}.@refill - @node Install an Info File, Command List, Create an Info File, Top @comment node-name, next, previous, up @chapter Installing an Info File @@ -13189,11 +12260,8 @@ @menu * Directory file:: The top level menu for all Info files. * New Info File:: Listing a new info file. -* Other Info Directories:: How to specify Info files that are +* Other Info Directories:: How to specify Info files that are located in other directories. -* Installing Dir Entries:: How to specify what menu entry to add - to the Info directory. -* Invoking install-info:: @code{install-info} options. @end menu @node Directory file, New Info File, Install an Info File, Install an Info File @@ -13218,8 +12286,8 @@ * Info: (info). Documentation browsing system. * Emacs: (emacs). The extensible, self-documenting text editor. -* Texinfo: (texinfo). With one source file, make - either a printed manual using +* Texinfo: (texinfo). With one source file, make + either a printed manual using TeX or an Info file. @dots{} @end group @@ -13248,11 +12316,11 @@ case letters---it can be written in either upper or lower case. Info has a feature that it will change the case of the file name to lower case if it cannot find the name as written.)@refill -@c !!! Can any file name be written in upper or lower case, + +@c !!! Can any file name be written in upper or lower case, @c or is dir a special case? @c Yes, apparently so, at least with Gillespie's Info. --rjc 24mar92 - - +@c @node New Info File, Other Info Directories, Directory file, Install an Info File @section Listing a New Info File @cindex Adding a new info file @@ -13261,10 +12329,11 @@ @cindex Info file, listing new one @cindex @file{dir} file listing -To add a new Info file to your system, you must write a menu entry to -add to the menu in the @file{dir} file in the @file{info} directory. -For example, if you were adding documentation for GDB, you would write -the following new entry:@refill +To add a new Info file to your system, write a menu entry for it in the +menu in the @file{dir} file in the @file{info} directory. Also, move +the new Info file itself to the @file{info} directory. For example, if +you were adding documentation for GDB, you would write the following new +entry:@refill @example * GDB: (gdb). The source-level C debugger. @@ -13273,17 +12342,22 @@ @noindent The first part of the menu entry is the menu entry name, followed by a colon. The second part is the name of the Info file, in parentheses, -followed by a period. The third part is the description. - -The name of an Info file often has a @file{.info} extension. Thus, the -Info file for GDB might be called either @file{gdb} or @file{gdb.info}. -The Info reader programs automatically try the file name both with and -without @file{.info}; so it is better to avoid clutter and not to write -@samp{.info} explicitly in the menu entry. For example, the GDB menu -entry should use just @samp{gdb} for the file name, not @samp{gdb.info}. - - -@node Other Info Directories, Installing Dir Entries, New Info File, Install an Info File +followed by a period. The third part is the description.@refill + +Conventionally, the name of an Info file has a @file{.info} extension. +Thus, you might list the name of the file like this: + +@example +* GDB: (gdb.info). The source-level C debugger. +@end example + +@noindent +However, Info will look for a file with a @file{.info} extension if it +does not find the file under the name given in the menu. This means +that you can refer to the file @file{gdb.info} as @file{gdb}, as shown +in the first example. This looks better. + +@node Other Info Directories, , New Info File, Install an Info File @comment node-name, next, previous, up @section Info Files in Other Directories @cindex Installing Info in another directory @@ -13304,58 +12378,60 @@ @code{Info-directory-list} variable in your personal or site initialization file. -This tells Emacs where to look for @file{dir} files. Emacs merges the -files named @file{dir} from each of the listed directories. (In Emacs -version 18, you can set the @code{Info-directory} variable to the name -of only one directory.)@refill - -@item -Specify the Info directory name in the @code{INFOPATH} environment -variable in your @file{.profile} or @file{.cshrc} initialization file. -(Only you and others who set this environment variable will be able to -find Info files whose location is specified this way.)@refill +This tells Emacs's Info reader reader where to look for @file{dir} +files. Emacs merges the files named @file{dir} from each of the listed +directories. (In Emacs Version 18, you can set the +@code{Info-directory} variable to the name of only one +directory.)@refill + +@item +Specify the @file{info} directory name in an environment variable in +your @file{.profile} or @file{.cshrc} initialization file. (Only you +and others who set this environment variable will be able to find Info +files whose location is specified this way.)@refill @end itemize -For example, to reach a test file in the @file{/home/bob/manuals} +For example, to reach a test file in the @file{~bob/manuals} directory, you could add an entry like this to the menu in the @file{dir} file:@refill @example -* Test: (/home/bob/manuals/info-test). Bob's own test file. +* Test: (/usr/bob/manuals/info-test). Bob's own test file. @end example @noindent In this case, the absolute file name of the @file{info-test} file is written as the second part of the menu entry.@refill -@vindex Info-directory-list +@vindex Info-directory-list Alternatively, you could write the following in your @file{.emacs} file:@refill @example @group (setq Info-directory-list - '("/home/bob/manuals" - "/usr/local/info")) + '("/usr/bob/manuals" + "/usr/local/emacs/info")) @end group @end example @c reworded to avoid overfill hbox This tells Emacs to merge the @file{dir} file from the -@file{/home/bob/manuals} directory with the @file{dir} file from the -@file{/usr/local/info} directory. Info will list the -@file{/home/bob/manuals/info-test} file as a menu entry in the -@file{/home/bob/manuals/dir} file.@refill +@file{/usr/bob/manuals} directory with the @file{dir} file from the +@file{"/usr/local/emacs/info}" directory. Info will list the +@file{/usr/bob/manuals/info-test} file as a menu entry in the +@file{/usr/bob/manuals/dir} file.@refill @vindex INFOPATH -Finally, you can tell Info where to look by setting the @code{INFOPATH} -environment variable in your @file{.cshrc} or @file{.profile} file. If -you use a Bourne-compatible shell such as @code{sh} or @code{bash} for -your shell command interpreter, you set the @code{INFOPATH} environment -variable in the @file{.profile} initialization file; but if you use -@code{csh} or @code{tcsh}, you must set the variable in the -@file{.cshrc} initialization file. The two types of shells use -different syntax. +Finally, you can tell Info where to look by setting the +@code{INFOPATH} environment variable in your @file{.cshrc} or +@file{.profile} file.@refill + +If you use @code{sh} or @code{bash} for your shell command interpreter, +you must set the @code{INFOPATH} environment variable in the +@file{.profile} initialization file; but if you use @code{csh}, you must +set the variable in the @file{.cshrc} initialization file. The two +files require slightly different command formats.@refill @itemize @bullet @item @@ -13363,7 +12439,7 @@ variable as follows:@refill @smallexample -setenv INFOPATH .:~/manuals:/usr/local/emacs/info +setenv INFOPATH .:~bob/manuals:/usr/local/emacs/info @end smallexample @item @@ -13371,174 +12447,17 @@ writing:@refill @smallexample -INFOPATH=.:$HOME/manuals:/usr/local/emacs/info +INFOPATH=.:~bob/manuals:/usr/local/emacs/info export INFOPATH @end smallexample @end itemize @noindent -The @samp{.} indicates the current directory as usual. Emacs uses the +The @samp{.} indicates the current directory. Emacs uses the @code{INFOPATH} environment variable to initialize the value of Emacs's own @code{Info-directory-list} variable. -@cindex @samp{:} @r{last in @code{INFOPATH}} -However you set @code{INFOPATH}, if its last character is a colon, this -is replaced by the default (compiled-in) path. This gives you a way to -augment the default path with new directories without having to list all -the standard places. For example (using @code{sh} syntax: - -@example -INFOPATH=/local/info: -export INFOPATH -@end example - -@noindent -will search @file{/local/info} first, then the standard directories. -Leading or doubled colons are not treated specially. - - -@node Installing Dir Entries, Invoking install-info, Other Info Directories, Install an Info File -@section Installing Info Directory Files - -When you install an Info file onto your system, you can use the program -@code{install-info} to update the Info directory file @file{dir}. -Normally the makefile for the package runs @code{install-info}, just -after copying the Info file into its proper installed location. - -@findex dircategory -@findex direntry -In order for the Info file to work with @code{install-info}, you should -use the commands @code{@@dircategory} and @code{@@direntry} in the -Texinfo source file. Use @code{@@direntry} to specify the menu entry to -add to the Info directory file, and use @code{@@dircategory} to specify -which part of the Info directory to put it in. Here is how these -commands are used in this manual: - -@smallexample -@@dircategory Texinfo documentation system -@@direntry -* Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. @dots{} -@dots{} -@@end direntry -@end smallexample - -Here's what this produces in the Info file: - -@smallexample -INFO-DIR-SECTION Texinfo documentation system -START-INFO-DIR-ENTRY -* Texinfo: (texinfo). The GNU documentation format. -* install-info: (texinfo)Invoking install-info. @dots{} -@dots{} -END-INFO-DIR-ENTRY -@end smallexample - -@noindent -The @code{install-info} program sees these lines in the Info file, and -that is how it knows what to do. - -Always use the @code{@@direntry} and @code{@@dircategory} commands near -the beginning of the Texinfo input, before the first @code{@@node} -command. If you use them later on in the input, @code{install-info} -will not notice them. - -If you use @code{@@dircategory} more than once in the Texinfo source, -each usage specifies one category; the new menu entry is added to the -Info directory file in each of the categories you specify. If you use -@code{@@direntry} more than once, each usage specifies one menu entry; -each of these menu entries is added to the directory in each of the -specified categories. - - -@node Invoking install-info, , Installing Dir Entries, Install an Info File -@section Invoking install-info - -@pindex install-info - -@code{install-info} inserts menu entries from an Info file into the -top-level @file{dir} file in the Info system (see the previous sections -for an explanation of how the @file{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: - -@example -install-info [@var{option}]@dots{} [@var{info-file} [@var{dir-file}]] -@end example - -If @var{info-file} or @var{dir-file} are not specified, the various -options (described below) that define them must be. There are no -compile-time defaults, and standard input is never used. -@code{install-info} can read only one info file and write only one dir -file per invocation. - -@cindex @file{dir}, created by @code{install-info} -If @var{dir-file} (however specified) does not exist, -@code{install-info} creates it if possible (with no entries). - -Options: - -@table @code -@item --delete -@opindex --delete -Delete the entries in @var{info-file} from @var{dir-file}. The file -name in the entry in @var{dir-file} must be @var{info-file} (except for -an optional @samp{.info} in either one). Don't insert any new entries. - -@item --dir-file=@var{name} -@opindex --dir-file=@var{name} -Specify file name of the Info directory file. This is equivalent to -using the @var{dir-file} argument. - -@item --entry=@var{text} -@opindex --entry=@var{text} -Insert @var{text} as an Info directory entry; @var{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 -added. If you don't specify any entries, they are determined from -information in the Info file itself. - -@item --help -@opindex --help -Display a usage message listing basic usage and all available options, -then exit successfully. - -@item --info-file=@var{file} -@opindex --info-file=@var{file} -Specify Info file to install in the directory. -This is equivalent to using the @var{info-file} argument. - -@item --info-dir=@var{dir} -@opindex --info-dir=@var{dir} -Equivalent to @samp{--dir-file=@var{dir}/dir}. - -@item --item=@var{text} -@opindex --item=@var{text} -Same as @samp{--entry=@var{text}}. An Info directory entry is actually -a menu item. - -@item --quiet -@opindex --quiet -Suppress warnings. - -@item --remove -@opindex --remove -Same as @samp{--delete}. - -@item --section=@var{sec} -@opindex --section=@var{sec} -Put this file's entries in section @var{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. - -@item --version -@opindex --version -@cindex version number, finding -Display version information and exit successfully. - -@end table - +@c ================ Appendix starts here ================ @node Command List, Tips, Install an Info File, Top @appendix @@-Command List @@ -13552,85 +12471,32 @@ @sp 1 @table @code -@item @@@var{whitespace} -An @code{@@} followed by a space, tab, or newline produces a normal, -stretchable, interword space. @xref{Multiple Spaces}. - -@item @@! -Generate an exclamation point that really does end a sentence (usually -after an end-of-sentence capital letter). @xref{Ending a Sentence}. - -@item @@" -@itemx @@' -Generate an umlaut or acute accent, respectively, over the next -character, as in @"o and @'o. @xref{Inserting Accents}. - @item @@* Force a line break. Do not end a paragraph that uses @code{@@*} with an @code{@@refill} command. @xref{Line Breaks}.@refill -@item @@,@{@var{c}@} -Generate a cedilla accent under @var{c}, as in @,{c}. @xref{Inserting -Accents}. - -@item @@- -Insert a discretionary hyphenation point. @xref{- and hyphenation}. - @item @@. -Produce a period that really does end a sentence (usually after an -end-of-sentence capital letter). @xref{Ending a Sentence}. +Stands for a period that really does end a sentence (usually after an +end-of-sentence capital letter). @xref{Controlling Spacing}.@refill @item @@: 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. -@xref{Not Ending a Sentence}.@refill - -@item @@= -Generate a macro (bar) accent over the next character, as in @=o. -@xref{Inserting Accents}. - -@item @@? -Generate a question mark that really does end a sentence (usually after -an end-of-sentence capital letter). @xref{Ending a Sentence}. +@xref{Controlling Spacing}.@refill @item @@@@ -Stands for an at sign, @samp{@@}. -@xref{Braces Atsigns, , Inserting @@ and braces}. - -@item @@^ -@itemx @@` -Generate a circumflex (hat) or grave accent, respectively, over the next -character, as in @^o. -@xref{Inserting Accents}. +Stands for @samp{@@}. @xref{Braces Atsigns Periods, , Inserting +@samp{@@}}.@refill @item @@@{ -Stands for a left brace, @samp{@{}. -@xref{Braces Atsigns, , Inserting @@ and braces}. +Stands for a left-hand brace, @samp{@{}.@* +@xref{Braces Atsigns Periods, , Inserting @@ braces and periods}.@refill @item @@@} Stands for a right-hand brace, @samp{@}}.@* -@xref{Braces Atsigns, , Inserting @@ and braces}. - -@item @@= -Generate a tilde accent over the next character, as in @~N. -@xref{Inserting Accents}. - -@item @@AA@{@} -@itemx @@aa@{@} -Generate the uppercase and lowercase Scandinavian A-ring letters, -respectively: @AA{}, @aa{}. @xref{Inserting Accents}. - -@item @@AE@{@} -@itemx @@ae@{@} -Generate the uppercase and lowercase AE ligatures, respectively: -@AE{}, @ae{}. @xref{Inserting Accents}. - -@item @@afourpaper -Change page dimensions for the A4 paper size. -Only allowed inside @code{@@iftex} @dots{} @code{@@end iftex}. -@xref{A4 Paper}. +@xref{Braces Atsigns Periods, , Inserting @@ braces and periods}.@refill @item @@appendix @var{title} Begin an appendix. The title appears in the table @@ -13653,10 +12519,10 @@ subheading, , Subsection Commands}.@refill @item @@appendixsubsubsec @var{title} -Begin an appendix subsubsection within an appendix subsection. The -title appears in the table of contents of a printed manual. In Info, -the title is underlined with periods. @xref{subsubsection,, The -`subsub' Commands}.@refill +Begin an appendix subsubsection within a subappendix. The title +appears in the table of contents of a printed manual. In Info, the +title is underlined with periods. @xref{subsubsection,, The `subsub' +Commands}.@refill @item @@asis Used following @code{@@table}, @code{@@ftable}, and @code{@@vtable} to @@ -13699,9 +12565,10 @@ Center the line of text following the command. @xref{titlefont center sp, , @code{@@center}}.@refill -@item @@centerchap @var{line-of-text} -Like @code{@@chapter}, but centers the chapter title. @xref{chapter,, -@code{@@chapter}}. +@item @@lowersections +Change subsequent chapters to sections, sections to subsections, and so +on. @xref{Raise/lower sections, , @code{@@raisesections} and +@code{@@lowersections}}.@refill @item @@chapheading @var{title} Print a chapter-like heading in the text, but not in the table of @@ -13727,7 +12594,7 @@ formatting text between subsequent pairs of @code{@@ifset @var{flag}} and @code{@@end ifset} commands, and preventing @code{@@value@{@var{flag}@}} from expanding to the value to which -@var{flag} is set. +@var{flag} is set. @xref{set clear value, , @code{@@set} @code{@@clear} @code{@@value}}.@refill @item @@code@{@var{sample-code}@} @@ -13760,14 +12627,12 @@ Indices}.@refill @item @@defcv @var{category} @var{class} @var{name} -@itemx @@defcvx @var{category} @var{class} @var{name} 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. -@xref{Definition Commands}, and @ref{deffnx,, Def Cmds in Detail}. +@xref{Definition Commands}.@refill @item @@deffn @var{category} @var{name} @var{arguments}@dots{} -@itemx @@deffnx @var{category} @var{name} @var{arguments}@dots{} Format a description for a function, interactive command, or similar entity that may take arguments. @code{@@deffn} takes as arguments the category of entity being described, the name of this particular @@ -13777,7 +12642,6 @@ Define a new index and its indexing command. Print entries in a roman font. @xref{New Indices, , Defining New Indices}.@refill -@c Unused so far as I can see and unsupported by makeinfo -- karl, 15sep96. @item @@definfoenclose @var{new-command}, @var{before}, @var{after}, Create new @@-command for Info that marks text by enclosing it in strings that precede and follow the text. Write definition inside of @@ -13785,160 +12649,109 @@ Highlighting}.@refill @item @@defivar @var{class} @var{instance-variable-name} -@itemx @@defivarx @var{class} @var{instance-variable-name} This command formats a description for an instance variable in object-oriented programming. The command is equivalent to @samp{@@defcv -@{Instance Variable@} @dots{}}. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +@{Instance Variable@} @dots{}}. @xref{Definition Commands}.@refill @item @@defmac @var{macro-name} @var{arguments}@dots{} -@itemx @@defmacx @var{macro-name} @var{arguments}@dots{} Format a description for a macro. The command is equivalent to -@samp{@@deffn Macro @dots{}}. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +@samp{@@deffn Macro @dots{}}. @xref{Definition Commands}.@refill @item @@defmethod @var{class} @var{method-name} @var{arguments}@dots{} -@itemx @@defmethodx @var{class} @var{method-name} @var{arguments}@dots{} Format a description for a method in object-oriented programming. The command is equivalent to @samp{@@defop Method @dots{}}. Takes as arguments the name of the class of the method, the name of the -method, and its arguments, if any. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +method, and its arguments, if any. @xref{Definition Commands}.@refill @item @@defop @var{category} @var{class} @var{name} @var{arguments}@dots{} -@itemx @@defopx @var{category} @var{class} @var{name} @var{arguments}@dots{} Format a description for an operation in object-oriented programming. @code{@@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. @xref{Definition -Commands}, and @ref{deffnx,, Def Cmds in Detail}. - +Commands}.@refill + +@need 100 @item @@defopt @var{option-name} -@itemx @@defoptx @var{option-name} Format a description for a user option. The command is equivalent to -@samp{@@defvr @{User Option@} @dots{}}. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. - +@samp{@@defvr @{User Option@} @dots{}}. @xref{Definition Commands}.@refill + +@need 100 @item @@defspec @var{special-form-name} @var{arguments}@dots{} -@itemx @@defspecx @var{special-form-name} @var{arguments}@dots{} Format a description for a special form. The command is equivalent to -@samp{@@deffn @{Special Form@} @dots{}}. @xref{Definition Commands}, -and @ref{deffnx,, Def Cmds in Detail}. - +@samp{@@deffn @{Special Form@} @dots{}}. @xref{Definition Commands}.@refill + +@need 200 @item @@deftp @var{category} @var{name-of-type} @var{attributes}@dots{} -@itemx @@deftpx @var{category} @var{name-of-type} @var{attributes}@dots{} -Format a description for a data type. @code{@@deftp} takes as arguments -the category, the name of the type (which is a word like @samp{int} or -@samp{float}), and then the names of attributes of objects of that type. -@xref{Definition Commands}, and @ref{deffnx,, Def Cmds in Detail}. +Format a description for a data type. @code{@@deftp} takes as +arguments the category, the name of the type (which is a word like +@samp{int} or @samp{float}), and then the names of attributes of +objects of that +type. @xref{Definition Commands}.@refill @item @@deftypefn @var{classification} @var{data-type} @var{name} @var{arguments}@dots{} -@itemx @@deftypefnx @var{classification} @var{data-type} @var{name} @var{arguments}@dots{} Format a description for a function or similar entity that may take -arguments and that is typed. @code{@@deftypefn} takes as arguments the -classification of entity being described, the type, the name of the -entity, and its arguments, if any. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +arguments and that is typed. @code{@@deftypefn} takes as arguments +the classification of entity being described, the type, the name of +the entity, and its arguments, if any. @xref{Definition +Commands}.@refill @item @@deftypefun @var{data-type} @var{function-name} @var{arguments}@dots{} -@itemx @@deftypefunx @var{data-type} @var{function-name} @var{arguments}@dots{} Format a description for a function in a typed language. The command is equivalent to @samp{@@deftypefn Function @dots{}}. -@xref{Definition Commands}, -and @ref{deffnx,, Def Cmds in Detail}. - -@item @@deftypemethod @var{class} @var{data-type} @var{method-name} @var{arguments}@dots{} -@itemx @@deftypemethodx @var{class} @var{data-type} @var{method-name} @var{arguments}@dots{} -Format a description for a typed method in object-oriented programming. -Takes as arguments the name of the class of the method, the return type -of the method, the name of the method, and its arguments, if any. -@xref{Definition Commands}, and @ref{deffnx,, Def Cmds in Detail}. +@xref{Definition Commands}.@refill @item @@deftypevr @var{classification} @var{data-type} @var{name} -@itemx @@deftypevrx @var{classification} @var{data-type} @var{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. @xref{Definition Commands}, and @ref{deffnx,, Def Cmds in -Detail}. +classification of entity being described, the type, and the name of +the entity. @xref{Definition Commands}.@refill @item @@deftypevar @var{data-type} @var{variable-name} -@itemx @@deftypevarx @var{data-type} @var{variable-name} Format a description for a variable in a typed language. The command is equivalent to @samp{@@deftypevr Variable @dots{}}. @xref{Definition -Commands}, and @ref{deffnx,, Def Cmds in Detail}. +Commands}.@refill @item @@defun @var{function-name} @var{arguments}@dots{} -@itemx @@defunx @var{function-name} @var{arguments}@dots{} Format a description for functions. The command is equivalent to -@samp{@@deffn Function @dots{}}. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +@samp{@@deffn Function @dots{}}. @xref{Definition Commands}.@refill @item @@defvar @var{variable-name} -@itemx @@defvarx @var{variable-name} Format a description for variables. The command is equivalent to -@samp{@@defvr Variable @dots{}}. @xref{Definition Commands}, and -@ref{deffnx,, Def Cmds in Detail}. +@samp{@@defvr Variable @dots{}}. @xref{Definition Commands}.@refill @item @@defvr @var{category} @var{name} -@itemx @@defvrx @var{category} @var{name} Format a description for any kind of variable. @code{@@defvr} takes as arguments the category of the entity and the name of the entity. -@xref{Definition Commands}, -and @ref{deffnx,, Def Cmds in Detail}. - -@item @@detailmenu@{@} -Avoid @code{makeinfo} confusion stemming from the detailed node listing -in a master menu. @xref{Master Menu Parts}. +@xref{Definition Commands}.@refill @item @@dfn@{@var{term}@} Highlight the introductory or defining use of a term. @xref{dfn, , @code{@@dfn}}.@refill -@item @@dircategory @var{dirpart} -Specify a part of the Info directory menu where this file's entry should -go. @xref{Installing Dir Entries}. - -@item @@direntry -Begin the Info directory menu entry for this file. -@xref{Installing Dir Entries}. - @need 100 @item @@display Begin a kind of example. Indent text, do not fill, do not select a new font. Pair with @code{@@end display}. @xref{display, , @code{@@display}}.@refill +@need 100 @item @@dmn@{@var{dimension}@} -Format a unit of measure, as in 12@dmn{pt}. Causes @TeX{} to insert a -thin space before @var{dimension}. No effect in Info. -@xref{dmn, , @code{@@dmn}}.@refill - -@item @@dotaccent@{@var{c}@} -Generate a dot accent over the character @var{c}, as in @dotaccent{oo}. -@xref{Inserting Accents}. - +Format a dimension. Cause @TeX{} to insert a narrow space before +@var{dimension}. No effect in Info. Use for writing a number +followed by an abbreviation of a dimension name, such as +@samp{12@dmn{pt}}, written as @samp{12@@dmn@{pt@}}, with no space +between the number and the @code{@@dmn} command. @xref{dmn, , +@code{@@dmn}}.@refill + +@need 100 @item @@dots@{@} Insert an ellipsis: @samp{@dots{}}. @xref{dots, , @code{@@dots}}.@refill -@item @@email@{@var{address}[, @var{displayed-text}]@} -Indicate an electronic mail address. -@xref{email, , @code{@@email}}.@refill - @need 100 @item @@emph@{@var{text}@} Highlight @var{text}; text is displayed in @emph{italics} in printed -output, and surrounded by asterisks in Info. @xref{Emphasis, , -Emphasizing Text}. - -@item @@end @var{environment} -Ends @var{environment}, as in @samp{@@end example}. @xref{Formatting -Commands,,@@-commands}. - -@item @@enddots@{@} -Generate an end-of-sentence of ellipsis, like this @enddots{} -@xref{dots,,@code{@@dots@{@}}}. +output, and surrounded by asterisks in Info. @xref{Emphasis, , Emphasizing Text}.@refill @need 100 @item @@enumerate [@var{number-or-letter}] @@ -13956,32 +12769,34 @@ Indicate to the reader with a glyph that the following text is an error message: @samp{@error{}}. @xref{Error Glyph}.@refill -@item @@evenfooting [@var{left}] @@| [@var{center}] @@| [@var{right}] -@itemx @@evenheading [@var{left}] @@| [@var{center}] @@| [@var{right}] -Specify page footings resp.@: headings for even-numbered (left-hand) -pages. Only allowed inside @code{@@iftex}. @xref{Custom Headings, , -How to Make Your Own Headings}.@refill +@item @@evenfooting [@var{left}] @@| [@var{center}] @@| [@var{right}] +Specify page footings for even-numbered (left-hand) pages. Not relevant to +Info. @xref{Custom Headings, , How to Make Your Own Headings}.@refill + +@item @@evenheading [@var{left}] @@| [@var{center}] @@| [@var{right}] +Specify page headings for even-numbered (left-hand) pages. Not relevant to +Info. @xref{Custom Headings, , How to Make Your Own Headings}.@refill @item @@everyfooting [@var{left}] @@| [@var{center}] @@| [@var{right}] -@itemx @@everyheading [@var{left}] @@| [@var{center}] @@| [@var{right}] -Specify page footings resp.@: headings for every page. Not relevant to -Info. @xref{Custom Headings, , How to Make Your Own Headings}.@refill +Specify page footings for every page. Not relevant to Info. @xref{Custom +Headings, , How to Make Your Own Headings}.@refill + +@item @@everyheading [@var{left}] @@| [@var{center}] @@| [@var{right}] +Specify page headings for every page. Not relevant to Info. @xref{Custom +Headings, , How to Make Your Own Headings}.@refill @item @@example Begin an example. Indent text, do not fill, and select fixed-width font. Pair with @code{@@end example}. @xref{example, , @code{@@example}}.@refill -@item @@exclamdown@{@} -Produce an upside-down exclamation point. @xref{Inserting Accents}. - @item @@exdent @var{line-of-text} Remove any indentation a line might have. @xref{exdent, , Undoing the Indentation of a Line}.@refill @item @@expansion@{@} Indicate the result of a macro expansion to the reader with a special -glyph: @samp{@expansion{}}. +glyph: @samp{@expansion{}}. @xref{expansion, , @expansion{} Indicating an Expansion}.@refill @item @@file@{@var{filename}@} @@ -13999,10 +12814,15 @@ @need 200 @item @@flushleft -@itemx @@flushright Left justify every line but leave the right end ragged. Leave font as is. Pair with @code{@@end flushleft}. -@code{@@flushright} analogous. +@xref{flushleft & flushright, , @code{@@flushleft} and +@code{@@flushright}}.@refill + +@need 200 +@item @@flushright +Right justify every line but leave the left end ragged. +Leave font as is. Pair with @code{@@end flushright}. @xref{flushleft & flushright, , @code{@@flushleft} and @code{@@flushright}}.@refill @@ -14035,9 +12855,6 @@ @code{@@end group}. Not relevant to Info. @xref{group, , @code{@@group}}.@refill -@item @@H@{@var{c}@} -Generate the long Hungarian umlaut accent over @var{c}, as in @H{o}. - @item @@heading @var{title} Print an unnumbered section-like heading in the text, but not in the table of contents of a printed manual. In Info, the title is @@ -14045,17 +12862,10 @@ , Section Commands}.@refill @item @@headings @var{on-off-single-double} -Turn page headings on or off, and/or specify single-sided or double-sided -page headings for printing. @xref{headings on off, , The -@code{@@headings} Command}. - -@item @@html -Enter HTML completely. Pair with @code{@@end html}. @xref{Raw -Formatter Commands}. - -@item @@hyphenation@{@var{hy-phen-a-ted words}@} -Explicitly define hyphenation points. @xref{- and hyphenation,, -@code{@@-} and @code{@@hyphenation}}. +Turn page headings on or off, or specify single-sided or double-sided +page headings for printing. @code{@@headings on} is synonymous with +@code{@@headings double}. @xref{headings on off, , The +@code{@@headings} Command}.@refill @item @@i@{@var{text}@} Print @var{text} in @i{italic} font. No effect in Info. @@ -14067,20 +12877,11 @@ ifclear} command. @xref{set clear value, , @code{@@set} @code{@@clear} @code{@@value}}.@refill -@item @@ifhtml -@itemx @@ifinfo -Begin a stretch of text that will be ignored by @TeX{} when it typesets -the printed manual. The text appears only in the HTML resp.@: Info -file. Pair with @code{@@end ifhtml} resp.@: @code{@@end ifinfo}. -@xref{Conditionals}. - -@item @@ifnothtml -@itemx @@ifnotinfo -@itemx @@ifnottex -Begin a stretch of text that will be ignored in one output format but -not the others. The text appears only in the format not specified. -Pair with @code{@@end ifnothtml} resp.@: @code{@@end ifnotinfo} resp.@: -@code{@@end ifnotinfo}. @xref{Conditionals}. +@item @@ifinfo +Begin a stretch of text that will be ignored by @TeX{} when it +typesets the printed manual. The text appears only in the Info file. +Pair with @code{@@end ifinfo}. @xref{Conditionals, , Conditionally +Visible Text}.@refill @item @@ifset @var{flag} If @var{flag} is set, the Texinfo formatting commands format text @@ -14098,10 +12899,6 @@ or the printed output. Pair with @code{@@end ignore}. @xref{Comments, , Comments and Ignored Text}.@refill -@item @@image@{@var{filename}, [@var{width}], [@var{height}]@} -Include graphics image in external @var{filename} scaled to the given -@var{width} and/or @var{height}. @xref{Images}. - @item @@include @var{filename} Incorporate the contents of the file @var{filename} into the Info file or printed document. @xref{Include Files}.@refill @@ -14115,7 +12912,7 @@ Use the specified macro definitions file. This command is used only in the first line of a Texinfo file to cause @TeX{} to make use of the @file{texinfo} macro definitions file. The backslash in @code{\input} -is used instead of an @code{@@} because @TeX{} does not +is used instead of an @code{@@} because @TeX{} does not properly recognize @code{@@} until after it has read the definitions file. @xref{Header, , The Texinfo File Header}.@refill @@ -14135,49 +12932,28 @@ item text. @xref{itemx, , @code{@@itemx}}.@refill @item @@kbd@{@var{keyboard-characters}@} -Indicate text that is characters of input to be typed by +Indicate text that consists of characters of input to be typed by users. @xref{kbd, , @code{@@kbd}}.@refill -@item @@kbdinputstyle @var{style} -Specify when @code{@@kbd} should use a font distinct from @code{@@code}. -@xref{kbd, , @code{@@kbd}}.@refill - @item @@key@{@var{key-name}@} -Indicate a name for a key on a keyboard. +Highlight @var{key-name}, a conventional name for a key on a keyboard. @xref{key, , @code{@@key}}.@refill @item @@kindex @var{entry} -Add @var{entry} to the index of keys. -@xref{Index Entries, , Defining the Entries of an Index}.@refill - -@item @@L@{@} -@itemx @@l@{@} -Generate the uppercase and lowercase Polish suppressed-L letters, -respectively: @L{}, @l{}. - -@c Possibly this can be tossed now that we have macros. --karl, 16sep96. -@c Yes, let's toss it, it's pretty weird. --karl, 15jun97. -@c @item @@global@@let@var{new-command}=@var{existing-command} -@c Equate a new highlighting command with an existing one. Only for -@c @TeX{}. Write definition inside of @code{@@iftex} @dots{} @code{@@end -@c iftex}. @xref{Customized Highlighting}.@refill +Add @var{entry} to the index of keys. @xref{Index Entries, , Defining the +Entries of an Index}.@refill + +@item @@global@@let@var{new-command}=@var{existing-command} +Equate a new highlighting command with an existing one. Only for +@TeX{}. Write definition inside of @code{@@iftex} @dots{} @code{@@end +iftex}. @xref{Customized Highlighting}.@refill @item @@lisp Begin an example of Lisp code. Indent text, do not fill, and select fixed-width font. Pair with @code{@@end lisp}. @xref{Lisp Example, , @code{@@lisp}}.@refill -@item @@lowersections -Change subsequent chapters to sections, sections to subsections, and so -on. @xref{Raise/lower sections, , @code{@@raisesections} and -@code{@@lowersections}}.@refill - -@item @@macro @var{macro-name} @{@var{params}@} -Define a new Texinfo command @code{@@@var{macro-name}@{@var{params}@}}. -Only supported by @code{makeinfo} and @code{texi2dvi}. @xref{Defining -Macros}. - -@item @@majorheading @var{title} +@item @@majorheading @var{title} Print a chapter-like heading in the text, but not in the table of contents of a printed manual. Generate more vertical whitespace before the heading than the @code{@@chapheading} command. In Info, the chapter @@ -14193,11 +12969,7 @@ manual. Pair with @code{@@end menu}. @xref{Menus}.@refill @item @@minus@{@} -Generate a minus sign, `@minus{}'. @xref{minus, , @code{@@minus}}.@refill - -@item @@multitable @var{column-width-spec} -Begin a multi-column table. Pair with @code{@@end multitable}. -@xref{Multitable Column Widths}. +Generate a minus sign. @xref{minus, , @code{@@minus}}.@refill @item @@need @var{n} Start a new page in a printed manual if fewer than @var{n} mils @@ -14208,25 +12980,18 @@ Define the beginning of a new node in Info, and serve as a locator for references for @TeX{}. @xref{node, , @code{@@node}}.@refill +@need 200 @item @@noindent Prevent text from being indented as if it were a new paragraph. @xref{noindent, , @code{@@noindent}}.@refill -@item @@O@{@} -@itemx @@o@{@} -Generate the uppercase and lowercase O-with-slash letters, respectively: -@O{}, @o{}. - -@item @@oddfooting [@var{left}] @@| [@var{center}] @@| [@var{right}] -@itemx @@oddheading [@var{left}] @@| [@var{center}] @@| [@var{right}] -Specify page footings resp.@: headings for odd-numbered (right-hand) -pages. Only allowed inside @code{@@iftex}. @xref{Custom Headings, , -How to Make Your Own Headings}.@refill - -@item @@OE@{@} -@itemx @@oe@{@} -Generate the uppercase and lowercase OE ligatures, respectively: -@OE{}, @oe{}. @xref{Inserting Accents}. +@item @@oddfooting [@var{left}] @@| [@var{center}] @@| [@var{right}] +Specify page footings for odd-numbered (right-hand) pages. Not relevant to +Info. @xref{Custom Headings, , How to Make Your Own Headings}.@refill + +@item @@oddheading [@var{left}] @@| [@var{center}] @@| [@var{right}] +Specify page headings for odd-numbered (right-hand) pages. Not relevant to +Info. @xref{Custom Headings, , How to Make Your Own Headings}.@refill @item @@page Start a new page in a printed manual. No effect in Info. @@ -14247,10 +13012,6 @@ glyph: @samp{@point{}}. @xref{Point Glyph, , Indicating Point in a Buffer}.@refill -@item @@pounds@{@} -Generate the pounds sterling currency sign. -@xref{pounds,,@code{@@pounds@{@}}}. - @item @@print@{@} Indicate printed output to the reader with a glyph: @samp{@print{}}. @xref{Print Glyph}.@refill @@ -14263,13 +13024,11 @@ @item @@pxref@{@var{node-name}, [@var{entry}], [@var{topic-or-title}], [@var{info-file}], [@var{manual}]@} Make a reference that starts with a lower case `see' in a printed manual. Use within parentheses only. Do not follow command with a -punctuation mark---the Info formatting commands automatically insert -terminating punctuation as needed. Only the first argument is mandatory. +punctuation mark. The Info formatting commands automatically insert +terminating punctuation as needed, which is why you do not need to +insert punctuation. Only the first argument is mandatory. @xref{pxref, , @code{@@pxref}}.@refill -@item @@questiondown@{@} -Generate an upside-down question mark. @xref{Inserting Accents}. - @item @@quotation Narrow the margins to indicate text that is quoted from another real or imaginary work. Write command on a line of its own. Pair with @@ -14304,10 +13063,6 @@ Indicate the result of an expression to the reader with a special glyph: @samp{@result{}}. @xref{result, , @code{@@result}}.@refill -@item @@ringaccent@{@var{c}@} -Generate a ring accent over the next character, as in @ringaccent{o}. -@xref{Inserting Accents}. - @item @@samp@{@var{text}@} Highlight @var{text} that is a literal example of a sequence of characters. Used for single characters, for statements, and often for @@ -14336,10 +13091,10 @@ odd-numbered (right-hand) new pages. @xref{setchapternewpage, , @code{@@setchapternewpage}}.@refill +@c awkward wording prevents overfull hbox @item @@setfilename @var{info-file-name} -Provide a name to be used by the Info file. This command is essential -for @TeX{} formatting as well, even though it produces no output. -@xref{setfilename, , @code{@@setfilename}}.@refill +Provide a name to be used by the Info file. @xref{setfilename, , +@code{@@setfilename}}.@refill @item @@settitle @var{title} Provide a title for page headers in a printed manual. @@ -14351,9 +13106,6 @@ @code{@@summarycontents}. @xref{Contents, , Generating a Table of Contents}.@refill -@item @@shorttitlepage@{@var{title}@} -Generate a minimal title page. @xref{titlepage,,@code{@@titlepage}}. - @need 400 @item @@smallbook Cause @TeX{} to produce a printed manual in a 7 by 9.25 inch format @@ -14380,11 +13132,8 @@ @item @@sp @var{n} Skip @var{n} blank lines. @xref{sp, , @code{@@sp}}.@refill -@item @@ss@{@} -Generate the German sharp-S es-zet letter, @ss{}. @xref{Inserting Accents}. - @need 700 -@item @@strong @var{text} +@item @@strong @var{text} Emphasize @var{text} by typesetting it in a @strong{bold} font for the printed manual and by surrounding it with asterisks for Info. @xref{emph & strong, , Emphasizing Text}.@refill @@ -14443,9 +13192,6 @@ Print @var{text} in a @t{fixed-width}, typewriter-like font. No effect in Info. @xref{Fonts}.@refill -@item @@tab -Separate columns in a multitable. @xref{Multitable Rows}. - @need 400 @item @@table @var{formatting-command} Begin a two-column table, using @code{@@item} for each entry. Write @@ -14453,7 +13199,7 @@ column entries are printed in the font resulting from @var{formatting-command}. Pair with @code{@@end table}. @xref{Two-column Tables, , Making a Two-column Table}. -Also see @ref{ftable vtable, , @code{@@ftable} and @code{@@vtable}}, +Also see @ref{ftable vtable, , @code{@@ftable} and @code{@@vtable}}, and @ref{itemx, , @code{@@itemx}}.@refill @item @@TeX@{@} @@ -14461,23 +13207,38 @@ and @copyright{}}.@refill @item @@tex -Enter @TeX{} completely. Pair with @code{@@end tex}. @xref{Raw -Formatter Commands}. +Enter @TeX{} completely. Pair with @code{@@end tex}. @xref{Using +Ordinary TeX Commands, , Using Ordinary @TeX{} Commands}.@refill @item @@thischapter -@itemx @@thischaptername -@itemx @@thisfile -@itemx @@thispage -@itemx @@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. @xref{Custom Headings, , How to Make Your Own +In a heading or footing, stands for the number and name of the current +chapter, in the format `Chapter 1: Title'. @xref{Custom +Headings, , How to Make Your Own Headings}.@refill + +@item @@thischaptername +In a heading or footing, stands for the name of the current chapter. +@xref{Custom Headings, , How to Make Your Own Headings}.@refill + +@item @@thisfile +In a heading or footing, stands for the name of the current +@code{@@include} file. Does not insert anything if not within an +@code{@@include} file. @xref{Custom Headings, , How to Make Your Own Headings}.@refill -@item @@tieaccent@{@var{cc}@} -Generate a tie-after accent over the next two characters @var{cc}, as in -`@tieaccent{oo}'. @xref{Inserting Accents}. +@item @@thispage +In a heading or footing, stands for the current page number. +@xref{Custom Headings, , How to Make Your Own Headings}.@refill + +@ignore +@item @@thissection +In a heading or footing, stands for the title of the current section. +@xref{Custom Headings, , How to Make Your Own Headings}.@refill +@end ignore + +@item @@thistitle +In a heading or footing, stands for the name of the document, as specified +by the @code{@@settitle} command. @xref{Custom Headings, , How to +Make Your Own Headings}.@refill @item @@tindex @var{entry} Add @var{entry} to the index of data types. @xref{Index Entries, , @@ -14520,13 +13281,6 @@ command is merely a synonym for @code{@@unnumbered}. @xref{makeinfo Pointer Creation, , Creating Pointers with @code{makeinfo}}. -@item @@u@{@var{c}@} -@itemx @@ubaraccent@{@var{c}@} -@itemx @@udotaccent@{@var{c}@} -Generate a breve, underbar, or underdot accent, respectively, over or -under the character @var{c}, as in @u{o}, @ubaraccent{o}, -@udotaccent{o}. @xref{Inserting Accents}. - @item @@unnumbered @var{title} In a printed manual, begin a chapter that appears without chapter numbers of any kind. The title appears in the table of contents of a @@ -14554,18 +13308,6 @@ manual. In Info, the title is underlined with periods. @xref{subsubsection, , The `subsub' Commands}.@refill -@item @@uref@{@var{url}[, @var{displayed-text}@} -Define a cross reference to an external uniform resource locator for the -World Wide Web. @xref{url, , @code{@@url}}.@refill - -@item @@url@{@var{url}@} -Indicate text that is a uniform resource locator for the World Wide -Web. @xref{url, , @code{@@url}}.@refill - -@item @@v@{@var{c}@} -Generate check accent over the character @var{c}, as in @v{o}. -@xref{Inserting Accents}. - @item @@value@{@var{flag}@} Replace @var{flag} with the value to which it is set by @code{@@set @var{flag}}. @@ -14602,6 +13344,7 @@ @item @@w@{@var{text}@} Prevent @var{text} from being split across two lines. Do not end a paragraph that uses @code{@@w} with an @code{@@refill} command. +In the Texinfo file, keep @var{text} on one line. @xref{w, , @code{@@w}}.@refill @need 400 @@ -14611,8 +13354,8 @@ mandatory. @xref{xref, , @code{@@xref}}.@refill @end table - @node Tips, Sample Texinfo File, Command List, Top +@comment node-name, next, previous, up @appendix Tips and Hints Here are some tips for writing Texinfo documentation:@refill @@ -14635,7 +13378,7 @@ Include a copyright notice and copying permissions. @end itemize -@subsubheading Index, Index, Index! +@subsubheading Index, index, index! Write many index entries, in different ways. Readers like indices; they are helpful and convenient. @@ -14651,7 +13394,8 @@ @itemize @bullet @item Write each index entry differently, so each entry refers to a different -place in the document. +place in the document. The index of an Info file lists only one +location for each entry. @item Write index entries only where a topic is discussed significantly. For @@ -14672,7 +13416,7 @@ use the appropriate case for case-sensitive names, such as those in C or Lisp. -@item +@item Write the indexing commands that refer to a whole section immediately after the section command, and write the indexing commands that refer to the paragraph before the paragraph. @@ -14701,7 +13445,7 @@ readers can look up the concept in different ways.) @end itemize -@subsubheading Blank Lines +@subsubheading Blank lines @itemize @bullet @item @@ -14714,7 +13458,7 @@ @item Always insert a blank line before an @code{@@table} command and after an @code{@@end table} command; but never insert a blank line after an -@code{@@table} command or before an @code{@@end table} command. +@code{@@table} command or before an @code{@@end table} command. @need 1000 For example, @@ -14745,7 +13489,7 @@ same way. @end itemize -@subsubheading Complete Phrases +@subsubheading Complete phrases Complete phrases are easier to read than @dots{} @@ -14761,7 +13505,7 @@ ``You can set these variables:''. The former expression sounds cut off. @end itemize -@subsubheading Editions, Dates and Versions +@subsubheading Editions, dates and versions Write the edition and version numbers and date in three places in every manual: @@ -14788,8 +13532,8 @@ @example @group @@c ===> NOTE! <== -@@c Specify the edition and version numbers and date -@@c in *three* places: +@@c Specify the edition and version numbers and date +@@c in *three* places: @@c 1. First ifinfo section 2. title page 3. top node @@c To find the locations, search for !!set @end group @@ -14797,14 +13541,14 @@ @group @@ifinfo @@c !!set edition, date, version -This is Edition 4.03, January 1992, +This is Edition 4.03, January 1992, of the @@cite@{GDB Manual@} for GDB Version 4.3. @dots{} @end group @end example @noindent ----or use @code{@@set} and @code{@@value} +---or use @code{@@set} and @code{@@value} (@pxref{value Example, , @code{@@value} Example}). @subsubheading Definition Commands @@ -14817,7 +13561,7 @@ @item Write just one definition command for each entity you define with a definition command. The automatic indexing feature creates an index -entry that leads the reader to the definition. +entry that leads the reader to the definition. @item Use @code{@@table} @dots{} @code{@@end table} in an appendix that @@ -14829,11 +13573,11 @@ @itemize @bullet @item -Capitalize ``Texinfo''; it is a name. Do not write the @samp{x} or +Capitalize @samp{Texinfo}; it is a name. Do not write the @samp{x} or @samp{i} in upper case. @item -Capitalize ``Info''; it is a name. +Capitalize @samp{Info}; it is a name. @item Write @TeX{} using the @code{@@TeX@{@}} command. Note the uppercase @@ -14854,7 +13598,7 @@ @group @@kbd@{C-x v@} @@kbd@{M-x vc-next-action@} - Perform the next logical operation + Perform the next logical operation on the version-controlled file corresponding to the current buffer. @end group @@ -14889,7 +13633,7 @@ @item Use @code{@@code} around Lisp symbols, including command names. For example, - + @example The main function is @@code@{vc-next-action@}, @dots{} @end example @@ -14905,16 +13649,15 @@ @item Use three hyphens in a row, @samp{---}, to indicate a long dash. @TeX{} typesets these as a long dash and the Info formatters reduce three -hyphens to two. +hyphens to two. @end itemize @subsubheading Periods Outside of Quotes Place periods and other punctuation marks @emph{outside} of quotations, -unless the punctuation is part of the quotation. This practice goes -against publishing conventions in the United States, but enables the -reader to distinguish between the contents of the quotation and the -whole passage. +unless the punctuation is part of the quotation. This practice goes against +convention, but enables the reader to distinguish between the contents +of the quotation and the whole passage. For example, you should write the following sentence with the period outside the end quotation marks: @@ -14931,8 +13674,8 @@ @itemize @bullet @item -Introduce new terms so that a reader who does not know them can -understand them from context; or write a definition for the term. +Introduce new terms so that a user who does not know them can understand +them from context; or write a definition for the term. For example, in the following, the terms ``check in'', ``register'' and ``delta'' are all appearing for the first time; the example sentence should be @@ -14946,8 +13689,8 @@ @item Use the @code{@@dfn} command around a word being introduced, to indicate -that the reader should not expect to know the meaning already, and -should expect to learn the meaning from this passage. +that the user should not expect to know the meaning already, and should +expect to learn the meaning from this passage. @end itemize @subsubheading @@pxref @@ -14956,7 +13699,7 @@ @ignore By the way, it is okay to use pxref with something else in front of it within the parens, as long as the pxref is followed by the close -paren, and the material inside the parens is not part of a larger +paren, and the material inside the parents is not part of a larger sentence. Also, you can use xref inside parens as part of a complete sentence so long as you terminate the cross reference with punctuation. @end ignore @@ -14969,20 +13712,20 @@ @subsubheading Invoking from a Shell -You can invoke programs such as Emacs, GCC, and @code{gawk} from a -shell. The documentation for each program should contain a section that +You can invoke programs such as Emacs, GCC, and GAWK from a shell. +The documentation for each program should contain a section that describes this. Unfortunately, if the node names and titles for these sections are all different, readers find it hard to search for the section.@refill -Name such sections with a phrase beginning with the word -@w{`Invoking @dots{}'}, as in `Invoking Emacs'; this way +Name such sections with a phrase beginning with the word +@w{`Invoking @dots{}'}, as in `Invoking Emacs'; this way users can find the section easily. -@subsubheading ANSI C Syntax +@subsubheading @sc{ansi c} Syntax When you use @code{@@example} to describe a C function's calling -conventions, use the ANSI C syntax, like this:@refill +conventions, use the @sc{ansi c} syntax, like this:@refill @example void dld_init (char *@@var@{path@}); @@ -15019,7 +13762,7 @@ in@} the new version.'' That flows better. @quotation -When you are done editing the file, you must perform a +When you are done editing the file, you must perform a @code{@@dfn}@{check in@}. @end quotation @@ -15045,7 +13788,7 @@ @item Pronounce @TeX{} as if the @samp{X} were a Greek `chi', as the last sound in the name `Bach'. But pronounce Texinfo as in `speck': -``teckinfo''. +@samp{teckinfo}. @item Write notes for yourself at the very end of a Texinfo file after the @@ -15054,8 +13797,8 @@ @code{@@end ignore}. @end itemize - @node Sample Texinfo File, Sample Permissions, Tips, Top +@comment node-name, next, previous, up @appendix A Sample Texinfo File @cindex Sample Texinfo file, no comments @@ -15065,7 +13808,7 @@ @sp 1 @example -\input texinfo @@c -*-texinfo-*- +\input texinfo @@c -*-texinfo-*- @@c %**start of header @@setfilename sample.info @@settitle Sample Document @@ -15090,11 +13833,11 @@ Copyright @@copyright@{@} 1990 Free Software Foundation, Inc. @@end titlepage -@@node Top, First Chapter, , (dir) +@@node Top, First Chapter, (dir), (dir) @@comment node-name, next, previous, up @@menu -* First Chapter:: The first chapter is the +* First Chapter:: The first chapter is the only chapter in this sample. * Concept Index:: This index has two entries. @@end menu @@ -15104,7 +13847,7 @@ @@chapter First Chapter @@cindex Sample index entry -This is the contents of the first chapter. +This is the contents of the first chapter. @@cindex Another sample index entry Here is a numbered list. @@ -15118,8 +13861,8 @@ @@end enumerate The @@code@{makeinfo@} and @@code@{texinfo-format-buffer@} -commands transform a Texinfo file such as this into -an Info file; and @@TeX@{@} typesets it for a printed +commands transform a Texinfo file such as this into +an Info file; and @@TeX@{@} typesets it for a printed manual. @@node Concept Index, , First Chapter, Top @@ -15132,7 +13875,6 @@ @@bye @end example - @node Sample Permissions, Include Files, Sample Texinfo File, Top @appendix Sample Permissions @cindex Permissions @@ -15213,13 +13955,13 @@ @example This file documents @dots{} -Copyright 1997 Free Software Foundation, Inc. +Copyright 1992 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. -@@ignore +@@ignore Permission is granted to process this file through TeX and print the results, provided the printed document carries a copying permission notice identical to this @@ -15237,8 +13979,8 @@ one. Permission is granted to copy and distribute -translations of this manual into another language, -under the above conditions for modified versions, +translations of this manual into another language, +under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation. @end example @@ -15268,20 +14010,20 @@ one. Permission is granted to copy and distribute -translations of this manual into another language, -under the above conditions for modified versions, +translations of this manual into another language, +under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation. @end example - @node Include Files, Headings, Sample Permissions, Top +@comment node-name, next, previous, up @appendix Include Files @cindex Include files When @TeX{} or an Info formatting command sees an @code{@@include} command in a Texinfo file, it processes the contents of the file named -by the command and incorporates them into the DVI or Info file being +by the command and incorporates them into the @sc{dvi} or Info file being created. Index entries from the included file are incorporated into the indices of the output file.@refill @@ -15300,7 +14042,7 @@ @end menu @node Using Include Files, texinfo-multiple-files-update, Include Files, Include Files -@appendixsec How to Use Include Files +@appendixsec How to Use Include Files @findex include To include another file within a Texinfo file, write the @@ -15473,13 +14215,13 @@ @group @@page @@vskip 0pt plus 1filll -Copyright @@copyright@{@} 1997 Free Software Foundation, Inc. +Copyright @@copyright@{@} 1990 Free Software Foundation, Inc. @@end titlepage @end group @group @@ifinfo -@@node Top, First, , (dir) +@@node Top, First, (dir), (dir) @@top Master Menu @@end ifinfo @end group @@ -15540,7 +14282,7 @@ References from one file to another were made by referring to the file name as well as the node name. (@xref{Other Info Files, , Referring to -Other Info Files}. Also, see @ref{Four and Five Arguments, , +Other Info Files}. Also, see @ref{Four and Five Arguments, , @code{@@xref} with Four and Five Arguments}.)@refill Include files were designed primarily as a way to create a single, @@ -15566,8 +14308,8 @@ you can write menus and cross references without naming the different Texinfo files.@refill - @node Headings, Catching Mistakes, Include Files, Top +@comment node-name, next, previous, up @appendix Page Headings @cindex Headings @cindex Footings @@ -15592,10 +14334,10 @@ @heading Headings Introduced @end ifinfo -Texinfo provides standard page heading formats for manuals that are -printed on one side of each sheet of paper and for manuals that are -printed on both sides of the paper. Typically, you will use these -formats, but you can specify your own format if you wish.@refill +Texinfo provides standard page heading formats for manuals that are printed +on one side of each sheet of paper and for manuals that are printed on +both sides of the paper. Usually, you will use one or other of these +formats, but you can specify your own format, if you wish.@refill In addition, you can specify whether chapters should begin on a new page, or merely continue the same page as the previous chapter; and if @@ -15689,9 +14431,9 @@ @end example @noindent -The chapter name is preceded by the word ``Chapter'', the chapter number -and a colon. This makes it easier to keep track of where you are in the -manual.@refill +The chapter name is preceded by the word @samp{Chapter}, the chapter +number and a colon. This makes it easier to keep track of where you +are in the manual.@refill @node Heading Choice, Custom Headings, Heading Format, Headings @comment node-name, next, previous, up @@ -15709,21 +14451,21 @@ There are four possibilities:@refill @table @asis -@item No @code{@@setchapternewpage} command +@item No @code{@@setchapternewpage} command Cause @TeX{} to specify the single-sided heading format, with chapters on new pages. This is the same as @code{@@setchapternewpage on}.@refill -@item @code{@@setchapternewpage on} +@item @code{@@setchapternewpage on} Specify the single-sided heading format, with chapters on new pages.@refill -@item @code{@@setchapternewpage off} +@item @code{@@setchapternewpage off} Cause @TeX{} to start a new chapter on the same page as the last page 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 @code{@@headings double} command; see @ref{headings on off, , The @code{@@headings} Command}.)@refill -@item @code{@@setchapternewpage odd} +@item @code{@@setchapternewpage odd} Specify the double-sided heading format, with chapters on new pages.@refill @end table @@ -15735,8 +14477,7 @@ @appendixsec How to Make Your Own Headings You can use the standard headings provided with Texinfo or specify -your own. By default, Texinfo has no footers, so if you specify them, -the available page size for the main text will be slightly reduced. +your own.@refill @c Following paragraph is verbose to prevent overfull hboxes. Texinfo provides six commands for specifying headings and @@ -15773,7 +14514,7 @@ @noindent You need to divide the left part from the central part and the central -part from the right part by inserting @samp{@@|} between parts. +part from the right had part by inserting @samp{@@|} between parts. Otherwise, the specification command will not be able to tell where the text for one part ends and the next part begins.@refill @@ -15809,7 +14550,7 @@ The `even' and `odd' commands specify the format for even-numbered pages and odd-numbered pages. These commands are for books and -manuals that are printed on both sides of each sheet of paper. +manuals that are printed on both sides of each sheet of paper.@refill @end table Use the @samp{@@this@dots{}} series of @@-commands to @@ -15826,7 +14567,7 @@ @findex thispage @item @@thispage Expands to the current page number.@refill -@c !!! Karl Berry says that `thissection' can fail on page breaks. +@c !!! Karl Berry says that `thissection' fails on page breaks. @ignore @item @@thissection Expands to the name of the current section.@refill @@ -15842,12 +14583,12 @@ chapter, in the format `Chapter 1: Title'.@refill @findex thistitle -@item @@thistitle +@item @@thistitle Expands to the name of the document, as specified by the @code{@@settitle} command.@refill @findex thisfile -@item @@thisfile +@item @@thisfile For @code{@@include} files only: expands to the name of the current @code{@@include} file. If the current Texinfo source file is not an @code{@@include} file, this command has no effect. This command does @@ -15878,8 +14619,8 @@ Beware of overlong titles: they may overlap another part of the header or footer and blot it out.@refill - @node Catching Mistakes, Refilling Paragraphs, Headings, Top +@comment node-name, next, previous, up @appendix Formatting Mistakes @cindex Structure, catching mistakes in @cindex Nodes, catching mistakes @@ -15906,7 +14647,7 @@ command and you can use the @kbd{M-x Info-validate} command.@refill @menu -* makeinfo Preferred:: @code{makeinfo} finds errors. +* makeinfo preferred:: @code{makeinfo} finds errors. * Debugging with Info:: How to catch errors with Info formatting. * Debugging with TeX:: How to catch errors with @TeX{} formatting. * Using texinfo-show-structure:: How to use @code{texinfo-show-structure}. @@ -15914,7 +14655,7 @@ * Running Info-Validate:: How to find badly referenced nodes. @end menu -@node makeinfo Preferred, Debugging with Info, Catching Mistakes, Catching Mistakes +@node makeinfo preferred, Debugging with Info, Catching Mistakes, Catching Mistakes @ifinfo @heading @code{makeinfo} Find Errors @end ifinfo @@ -15933,7 +14674,7 @@ cannot use @code{makeinfo}, or your problem is very puzzling, then you may want to use the tools described in this appendix.@refill -@node Debugging with Info, Debugging with TeX, makeinfo Preferred, Catching Mistakes +@node Debugging with Info, Debugging with TeX, makeinfo preferred, Catching Mistakes @comment node-name, next, previous, up @appendixsec Catching Errors with Info Formatting @cindex Catching errors with Info formatting @@ -15973,10 +14714,10 @@ ---------- Buffer: *Info Region* ---------- * Menu: -* Using texinfo-show-structure:: How to use +* Using texinfo-show-structure:: How to use `texinfo-show-structure' to catch mistakes. -* Running Info-Validate:: How to check for +* Running Info-Validate:: How to check for unreferenced nodes. @@end menus @point{} @@ -16051,7 +14792,7 @@ @c appendixsubsec Using the Emacs Lisp Debugger @c index Using the Emacs Lisp debugger @c index Emacs Lisp debugger -@c index Debugger, using the Emacs Lisp +@c index Debugger, using the Emacs Lisp If an error is especially elusive, you can turn on the Emacs Lisp debugger and look at the backtrace; this tells you where in the @@ -16154,19 +14895,19 @@ @example ---------- Buffer: *tex-shell* ---------- Runaway argument? -@{sorting indices, for more information about sorting +@{sorting indices, for more information about sorting indices.) @@refill @@ETC. ! Paragraph ended before @@xref was complete. -<to be read again> - @@par -l.27 - -? +<to be read again> + @@par +l.27 + +? ---------- Buffer: *tex-shell* ---------- @end example In this case, @TeX{} produced an accurate and -understandable error message: +understandable error message: @example Paragraph ended before @@xref was complete. @@ -16189,18 +14930,18 @@ You can tell @TeX{} to continue running and ignore just this error by typing @key{RET} at the @samp{?} prompt.@refill -@item +@item You can tell @TeX{} to continue running and to ignore all errors as best it can by typing @kbd{r @key{RET}} at the @samp{?} prompt.@refill This is often the best thing to do. However, beware: the one error may produce a cascade of additional error messages as its consequences -are felt through the rest of the file. To stop @TeX{} when it is -producing such an avalanche of error messages, type @kbd{C-c} (or -@kbd{C-c C-c}, if you are running a shell inside Emacs). - -@item -You can tell @TeX{} to stop this run by typing @kbd{x @key{RET}} +are felt through the rest of the file. (To stop @TeX{} when it is +producing such an avalanche of error messages, type @kbd{C-d} (or +@kbd{C-c C-d}, if you are running a shell inside Emacs.))@refill + +@item +You can tell @TeX{} to stop this run by typing @kbd{x @key{RET}} at the @samp{?} prompt.@refill @end enumerate @@ -16212,7 +14953,7 @@ though there is a problem. This usually occurs if a command is not ended but @TeX{} is able to continue processing anyhow. For example, if you fail to end an itemized list with the @code{@@end itemize} command, @TeX{} will -write a DVI file that you can print out. The only error message that +write a @sc{dvi} file that you can print out. The only error message that @TeX{} will give you is the somewhat mysterious comment that@refill @example @@ -16220,7 +14961,7 @@ @end example @noindent -However, if you print the DVI file, you will find that the text +However, if you print the @sc{dvi} file, you will find that the text of the file that follows the itemized list is entirely indented as if it were part of the last item in the itemized list. The error message is the way @TeX{} says that it expected to find an @code{@@end} @@ -16238,7 +14979,8 @@ The @samp{*} indicates that @TeX{} is waiting for input.@refill @example -This is TeX, Version 3.14159 (Web2c 7.0) +This is TeX, Version 2.0 for Berkeley UNIX +(preloaded format=plain-cm 87.10.25) (test.texinfo [1]) * @end example @@ -16264,7 +15006,7 @@ command lists all the lines that begin with the @@-commands that specify the structure: @code{@@chapter}, @code{@@section}, @code{@@appendix}, and so on. With an argument (@w{@kbd{C-u}} -as prefix argument, if interactive), +as prefix argument, if interactive), the command also shows the @code{@@node} lines. The @code{texinfo-show-structure} command is bound to @kbd{C-c C-s} in Texinfo mode, by default.@refill @@ -16276,7 +15018,7 @@ @example @group Lines matching "^@@\\(chapter \\|sect\\|subs\\|subh\\| - unnum\\|major\\|chapheading \\|heading \\|appendix\\)" + unnum\\|major\\|chapheading \\|heading \\|appendix\\)" in buffer texinfo.texi. @dots{} 4177:@@chapter Nodes @@ -16325,7 +15067,7 @@ @node Using occur, Running Info-Validate, Using texinfo-show-structure, Catching Mistakes @comment node-name, next, previous, up @appendixsec Using @code{occur} -@cindex Occurrences, listing with @code{@@occur} +@cindex Occurrences, listing with @code{@@occur} @findex occur Sometimes the @code{texinfo-show-structure} command produces too much @@ -16338,7 +15080,7 @@ @kbd{M-x occur} @end example -@noindent +@noindent and then, when prompted, type a @dfn{regexp}, a regular expression for the pattern you want to match. (@xref{Regexps, , Regular Expressions, emacs, The GNU Emacs Manual}.) The @code{occur} command works from @@ -16370,7 +15112,7 @@ @cindex Checking for badly referenced nodes @cindex Looking for badly referenced nodes @cindex Finding badly referenced nodes -@cindex Badly referenced nodes +@cindex Badly referenced nodes You can use the @code{Info-validate} command to check whether any of the `Next', `Previous', `Up' or other node pointers fail to point to a @@ -16499,7 +15241,7 @@ @end example @noindent -(Note the upper case @samp{I} in @code{Info-tagify}.) This creates an +(Note the upper case @key{I} in @code{Info-tagify}.) This creates an Info file with a tag table that you can validate.@refill The third step is to validate the Info file:@refill @@ -16509,7 +15251,7 @@ @end example @noindent -(Note the upper case @samp{I} in @code{Info-validate}.) +(Note the upper case @key{I} in @code{Info-validate}.) In brief, the steps are:@refill @example @@ -16576,11 +15318,11 @@ The primary file still functions as an Info file, but it contains just the tag table and a directory of subfiles.@refill - @node Refilling Paragraphs, Command Syntax, Catching Mistakes, Top +@comment node-name, next, previous, up @appendix Refilling Paragraphs -@cindex Refilling paragraphs -@cindex Filling paragraphs +@cindex Refilling paragraphs +@cindex Filling paragraphs @findex refill The @code{@@refill} command refills and, optionally, indents the first @@ -16615,26 +15357,24 @@ the ends of paragraphs that contain @code{@@*} or @w{@code{@@w@{ @dots{}@}}} and therefore do not refill or indent them.@refill - @node Command Syntax, Obtaining TeX, Refilling Paragraphs, Top @comment node-name, next, previous, up @appendix @@-Command Syntax @cindex @@-command syntax The character @samp{@@} is used to start special Texinfo commands. -(It has the same meaning that @samp{\} has in plain @TeX{}.) Texinfo +(It has the same meaning that @samp{\} has in Plain@TeX{}.) Texinfo has four types of @@-command:@refill @table @asis @item 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: @code{@@.}, @code{@@:}, @code{@@*}, @code{@@@kbd{SPACE}}, -@code{@@@kbd{TAB}}, @code{@@@kbd{NL}}, @code{@@@@}, @code{@@@{}, and -@code{@@@}}.@refill +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: @code{@@.}, @code{@@:}, @code{@@*}, @code{@@@@}, +@code{@@@{}, and @code{@@@}}.@refill @item 2. Alphabetic commands that do not require arguments. These commands start with @@ followed by a word followed by left- and @@ -16679,36 +15419,24 @@ Emacs paragraph commands because it cannot appear at the beginning of a line.@refill - -@node Obtaining TeX, Command and Variable Index, Command Syntax, Top +@node Obtaining TeX, New Features, Command Syntax, Top @appendix How to Obtain @TeX{} @cindex Obtaining @TeX{} @cindex @TeX{}, how to obtain @c !!! Here is information about obtaining TeX. Update it whenever. -@c !!! Also consider updating TeX.README on prep. -@c Updated by RJC on 1 March 1995, conversation with MacKay. -@c Updated by kb@cs.umb.edu on 29 July 1996. -@c Updated by kb@cs.umb.edu on 25 April 1997. +@c Last updated by RJC on 1 March 1995, conversation with Mackay. @TeX{} is freely redistributable. You can obtain @TeX{} for Unix -systems via anonymous ftp or on physical media. The core material -consists of the Web2c @TeX{} distribution (@uref{http://www.tug.org/web2c}). - -Instructions for retrieval by anonymous ftp and information on other -available distributions: -@example -@uref{ftp://ftp.tug.org/tex/unixtex.ftp} -@uref{http://www.tug.org/unixtex.ftp} -@end example - -The Free Software Foundation provides a core distribution on its Source -Code CD-ROM suitable for printing Texinfo manuals; the University of -Washington maintains and supports a tape distribution; the @TeX{} Users -Group co-sponsors a complete CD-ROM @TeX{} distribution. - -@itemize @bullet - -@item +systems via anonymous ftp or on tape or CD-ROM. The core material +consists of Karl Berry's @code{web2c} @TeX{} package. + +On-line retrieval instructions are in @code{ftp.cs.umb.edu} +@t{[158.121.104.33]} in @file{pub/tex/unixtex.ftp} + +The Free Software Foundation provides a core distribution on its +Source Code CD-ROM; the University of Washington maintains and +supports a tape distribution. + For the FSF Source Code CD-ROM, please contact: @iftex @@ -16716,14 +15444,15 @@ @group Free Software Foundation, Inc. 59 Temple Place Suite 330 -Boston, MA @ @ 02111-1307 +Boston, MA @w{ } 02111-1307 USA + Telephone: @w{@t{+}1--617--542--5942} Fax: (including Japan) @w{@t{+}1--617--542--2652} Free Dial Fax (in Japan): @w{ } @w{ } @w{ } 0031--13--2473 (KDD) @w{ } @w{ } @w{ } 0066--3382--0158 (IDC) -Electronic mail: @code{gnu@@prep.ai.mit.edu} +Electronic mail: @code{gnu@@prep.ai.mit.edu} @end group @end display @end iftex @@ -16740,49 +15469,57 @@ Free Dial Fax (in Japan): @w{ } @w{ } @w{ } 0031-13-2473 (KDD) @w{ } @w{ } @w{ } 0066-3382-0158 (IDC) -Electronic mail: @code{gnu@@prep.ai.mit.edu} +Electronic mail: @code{gnu@@prep.ai.mit.edu} @end group @end display @end ifinfo -@item -To order a complete distribution on CD-ROM, please see -@uref{http://www.tug.org/tex-live.html}. (This distribution is also -available by FTP; see the URL's above.) - -@item -To order a full distribution from the University of Washington on either -a 1/4@dmn{in} 4-track QIC-24 cartridge or a 4@dmn{mm} DAT cartridge, -send $210 to: - +To order a full distribution from the University of Washington on either a +1/4@dmn{inch} 4-track QIC-24 cartridge or a 4@dmn{mm} DAT cartridge, send +$210.00 to: + +@iftex @display @group Pierre A. MacKay -Denny Hall, Mail Stop DH-10 +Department of Classics +DH-10, Denny Hall 218 University of Washington Seattle, WA @w{ } 98195 USA + Telephone: @t{+}1--206--543--2268 Electronic mail: @code{mackay@@cs.washington.edu} @end group @end display - -@noindent Please make checks payable to the University of Washington. -Checks must be in U.S.@: dollars, drawn on a U.S.@: bank. Overseas -sites: please add to the base cost, if desired, $20.00 for shipment via -air parcel post, or $30.00 for shipment via courier. - -@end itemize - -Many other @TeX{} distributions are available; see -@uref{http://www.tug.org/}. - - -@c These are no longer ``new'', and the explanations -@c are all given elsewhere anyway, I think. --karl, 25apr97. -@ignore (the entire appendix) -@c node New Features, Command and Variable Index, Obtaining TeX, Top -@c appendix Second Edition Features +@end iftex +@ifinfo +@display +@group +Pierre A. MacKay +Department of Classics +DH-10, Denny Hall 218 +University of Washington +Seattle, WA @w{ } 98195 +USA + +Telephone: @t{+}1-206-543-2268 +Electronic mail: @code{mackay@@cs.washington.edu} +@end group +@end display +@end ifinfo + +Please make checks payable to the University of Washington. +Checks must be in U.S.@: dollars, drawn on a U.S.@: bank. + +Prepaid orders are the only orders that can now be handled. Overseas +sites: please add to the base cost, if desired, $20.00 for shipment +via air parcel post, or $30.00 for shipment via courier. + +Please check with the above for current prices and formats. + +@node New Features, Command and Variable Index, Obtaining TeX, Top +@appendix Second Edition Features @tex % Widen the space for the first column so three control-character @@ -16803,8 +15540,8 @@ * New Commands:: Many newly described @@-commands. @end menu -@c node New Texinfo Mode Commands, New Commands, Obtaining TeX, Obtaining TeX -@c appendixsec New Texinfo Mode Commands +@node New Texinfo Mode Commands, New Commands, New Features, New Features +@appendixsec New Texinfo Mode Commands Texinfo mode provides commands and features especially designed for working with Texinfo files. More than 20 new commands have been @@ -16813,7 +15550,7 @@ The keybindings are intended to be somewhat mnemonic.@refill -@c subheading Update all nodes and menus +@subheading Update all nodes and menus The @code{texinfo-master-menu} command is the primary command: @@ -16826,7 +15563,7 @@ and regular menus. @end table -@c subheading Update Pointers +@subheading Update Pointers @noindent Create or update `Next', `Previous', and `Up' node pointers.@refill @@ -16844,7 +15581,7 @@ Update every node in the buffer. @end table -@c subheading Update Menus +@subheading Update Menus @noindent Create or update menus.@refill @@ -16864,7 +15601,7 @@ first update all the nodes. @end table -@c subheading Insert Title as Description +@subheading Insert Title as Description @noindent Insert a node's chapter or section title in the space for the @@ -16880,7 +15617,7 @@ Insert title. @end table -@c subheading Format for Info +@subheading Format for Info @noindent Provide keybindings both for the Info formatting commands that are @@ -16918,7 +15655,7 @@ Kill the @code{makeinfo} formatting job. @end table -@c subheading Typeset and Print +@subheading Typeset and Print @noindent Typeset and print Texinfo documents from within Emacs.@refill @@ -16943,7 +15680,7 @@ Run @code{texindex}. @item C-c C-t C-p -Print the DVI file. +Print the @sc{dvi} file. @item C-c C-t C-q Show the print queue. @@ -16961,7 +15698,7 @@ Recenter the output buffer. @end table -@c subheading Other Updating Commands +@subheading Other Updating Commands @noindent The ``other updating commands'' do not have standard keybindings because @@ -16989,8 +15726,8 @@ Insert node pointers in strict sequence. @end table -@c node New Commands, , New Texinfo Mode Commands, Obtaining TeX -@c appendixsec New Texinfo @@-Commands +@node New Commands, , New Texinfo Mode Commands, New Features +@appendixsec New Texinfo @@-Commands The second edition of the Texinfo manual describes more than 50 commands that were not described in the first edition. A third or so @@ -16998,7 +15735,7 @@ manual; the others are new. Here is a listing, with brief descriptions of them:@refill -@c subheading Indexing +@subheading Indexing @noindent Create your own index, and merge indices.@refill @@ -17011,13 +15748,13 @@ Define a new index and its indexing command. See also the @code{@@defcodeindex} command. -@c written verbosely to avoid overfull hbox +@c written verbosely to avoid overful hbox @item @@synindex @var{from-index} @var{into-index} Merge the @var{from-index} index into the @var{into-index} index. See also the @code{@@syncodeindex} command. @end table -@c subheading Definitions +@subheading Definitions @noindent Describe functions, variables, macros, @@ -17036,7 +15773,7 @@ 15 other related commands. @end table -@c subheading Glyphs +@subheading Glyphs @noindent Indicate the results of evaluation, expansion, @@ -17047,11 +15784,11 @@ @xref{Glyphs}. @table @kbd -@item @@equiv@{@} +@item @@equiv@{@} @itemx @equiv{} Equivalence: -@item @@error@{@} +@item @@error@{@} @itemx @error{} Error message @@ -17059,20 +15796,20 @@ @itemx @expansion{} Macro expansion -@item @@point@{@} +@item @@point@{@} @itemx @point{} Position of point -@item @@print@{@} +@item @@print@{@} @itemx @print{} Printed output -@item @@result@{@} +@item @@result@{@} @itemx @result{} Result of an expression @end table -@c subheading Page Headings +@subheading Page Headings @noindent Customize page headings. @@ -17090,14 +15827,14 @@ @item @@evenheading, @@everyheading, @@oddheading, @dots{} Five other related commands. -@item @@thischapter +@item @@thischapter Insert name of chapter and chapter number. @item @@thischaptername, @@thisfile, @@thistitle, @@thispage Related commands. @end table -@c subheading Formatting +@subheading Formatting @noindent Format blocks of text. @@ -17116,13 +15853,13 @@ @item @@exdent @var{line-of-text} Remove indentation. -@item @@flushleft +@item @@flushleft Left justify. @item @@flushright Right justify. -@item @@format +@item @@format Do not narrow nor change font. @item @@ftable @var{formatting-command} @@ -17132,12 +15869,12 @@ @item @@lisp For an example of Lisp code. -@item @@smallexample +@item @@smallexample @itemx @@smalllisp Like @@table and @@lisp @r{but for} @@smallbook. @end table -@c subheading Conditionals +@subheading Conditionals @noindent Conditionally format text. @@ -17146,7 +15883,7 @@ @xref{set clear value, , @code{@@set} @code{@@clear} @code{@@value}}.@refill @table @kbd -@item @@set @var{flag} [@var{string}] +@item @@set @var{flag} [@var{string}] Set a flag. Optionally, set value of @var{flag} to @var{string}. @@ -17163,7 +15900,7 @@ Ignore, if @var{flag} is set. @end table -@c subheading @@heading series for Titles +@subheading @@heading series for Titles @noindent Produce unnumbered headings that do not appear in a table of contents. @@ -17176,12 +15913,12 @@ Unnumbered section-like heading not listed in the table of contents of a printed manual. -@item @@chapheading, @@majorheading, @@c subheading, @@subsubheading +@item @@chapheading, @@majorheading, @@subheading, @@subsubheading Related commands. @end table @need 1000 -@c subheading Font commands +@subheading Font commands @need 1000 @noindent @@ -17191,12 +15928,12 @@ @table @kbd @item @@r@{@var{text}@} Print in roman font. - + @item @@sc@{@var{text}@} Print in @sc{small caps} font. @end table -@c subheading Miscellaneous +@subheading Miscellaneous @noindent See @ref{title subtitle author, , @code{@@title} @code{@@subtitle} and @code{@@author} Commands},@* @@ -17212,12 +15949,13 @@ see @ref{title subtitle author, , @code{@@title} @code{@@subtitle} and @code{@@author}}, and@* see @ref{Custom Headings, , How to Make Your Own Headings}. +@need 700 @table @kbd @item @@author @var{author} Typeset author's name. -@c @item @@definfoenclose @var{new-command}, @var{before}, @var{after}, -@c Define a highlighting command for Info. (Info only.) +@item @@definfoenclose @var{new-command}, @var{before}, @var{after}, +Define a highlighting command for Info. (Info only.) @item @@finalout Produce cleaner printed output. @@ -17250,7 +15988,7 @@ Make a reference. In the printed manual, the reference does not start with the word `see'. -@item @@title @var{title} +@item @@title @var{title} Typeset @var{title} in the alternative title page format. @@ -17265,25 +16003,23 @@ % Switch width of first column of tables back to default value \global\tableindent=.8in @end tex -@end ignore - -@node Command and Variable Index, Concept Index, Obtaining TeX, Top + +@node Command and Variable Index, Concept Index, New Features, Top @comment node-name, next, previous, up @unnumbered Command and Variable Index -This is an alphabetical list of all the @@-commands, assorted Emacs Lisp -functions, and several variables. To make the list easier to use, the -commands are listed without their preceding @samp{@@}.@refill +This is an alphabetical list of all the @@-commands and several +variables. To make the list easier to use, the commands are listed +without their preceding @samp{@@}.@refill @printindex fn - @node Concept Index, , Command and Variable Index, Top +@comment node-name, next, previous, up @unnumbered Concept Index @printindex cp - @summarycontents @contents @bye