home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / gnu / texinfo-3.1-bin.lha / info / texi.info-8 (.txt) < prev    next >
GNU Info File  |  1994-02-24  |  43KB  |  822 lines
  1. This is Info file texi.info, produced by Makeinfo-1.55 from the input
  2. file texi.texi.
  3.    This file documents Texinfo, a documentation system that uses a
  4. single source file to produce both on-line information and a printed
  5. manual.
  6.    Copyright (C) 1988, 1990, 1991, 1992, 1993 Free Software Foundation,
  7.    This is the second edition of the Texinfo documentation,
  8. and is consistent with version 2 of `texinfo.tex'.
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that
  14. the entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that this permission notice may be stated in a
  19. translation approved by the Free Software Foundation.
  20. File: texi.info,  Node: Batch Formatting,  Next: Tag and Split Files,  Prev: texinfo-format commands,  Up: Create an Info File
  21. Batch Formatting
  22. ================
  23.    You can format Texinfo files for Info using `batch-texinfo-format'
  24. and Emacs Batch mode.  You can run Emacs in Batch mode from any shell,
  25. including a shell inside of Emacs.  (*Note Command Line Switches and
  26. Arguments: (emacs)Command Switches.)
  27.    Here is the command to format all the files that end in `.texinfo'
  28. in the current directory (where `%' is the shell prompt):
  29.      % emacs -batch -funcall batch-texinfo-format *.texinfo
  30. Emacs processes all the files listed on the command line, even if an
  31. error occurs while attempting to format some of them.
  32.    Run `batch-texinfo-format' only with Emacs in Batch mode as shown;
  33. it is not interactive.  It kills the Batch mode Emacs on completion.
  34.    `batch-texinfo-format' is convenient if you lack `makeinfo' and want
  35. to format several Texinfo files at once.  When you use Batch mode, you
  36. create a new Emacs process.  This frees your current Emacs, so you can
  37. continue working in it.  (When you run `texinfo-format-region' or
  38. `texinfo-format-buffer', you cannot use that Emacs for anything else
  39. until the command finishes.)
  40. File: texi.info,  Node: Tag and Split Files,  Prev: Batch Formatting,  Up: Create an Info File
  41. Tag Files and Split Files
  42. =========================
  43.    If a Texinfo file has more than 30,000 bytes,
  44. `texinfo-format-buffer' automatically creates a tag table for its Info
  45. file;  `makeinfo' always creates a tag table.  With a "tag table", Info
  46. can jump to new nodes more quickly than it can otherwise.
  47.    In addition, if the Texinfo file contains more than about 70,000
  48. bytes, `texinfo-format-buffer' and `makeinfo' split the large Info file
  49. into shorter "indirect" subfiles of about 50,000 bytes each.  Big files
  50. are split into smaller files so that Emacs does not need to make a
  51. large buffer to hold the whole of a large Info file; instead, Emacs
  52. allocates just enough memory for the small, split off file that is
  53. needed at the time.  This way, Emacs avoids wasting memory when you run
  54. Info.  (Before splitting was implemented, Info files were always kept
  55. short and "include files" were designed as a way to create a single,
  56. large printed manual out of the smaller Info files.  *Note Include
  57. Files::, for more information.  Include files are still used for very
  58. large documents, such as `The Emacs Lisp Reference Manual', in which
  59. each chapter is a separate file.)
  60.    When a file is split, Info itself makes use of a shortened version of
  61. the original file that contains just the tag table and references to
  62. the files that were split off.  The split off files are called
  63. "indirect" files.
  64.    The split off files have names that are created by appending `-1',
  65. `-2', `-3' and so on to the file name specified by the `@setfilename'
  66. command.  The shortened version of the original file continues to have
  67. the name specified by `@setfilename'.
  68.    At one stage in writing this document, for example, the Info file
  69. was saved as `test-texinfo' and that file looked like this:
  70.      Info file: test-texinfo,    -*-Text-*-
  71.      produced by texinfo-format-buffer
  72.      from file: new-texinfo-manual.texinfo
  73.      
  74.      ^_
  75.      Indirect:
  76.      test-texinfo-1: 102
  77.      test-texinfo-2: 50422
  78.      test-texinfo-3: 101300
  79.      ^_^L
  80.      Tag table:
  81.      (Indirect)
  82.      Node: overview^?104
  83.      Node: info file^?1271
  84.      Node: printed manual^?4853
  85.      Node: conventions^?6855
  86.      ...
  87. (But `test-texinfo' had far more nodes than are shown here.)  Each of
  88. the split off, indirect files, `test-texinfo-1', `test-texinfo-2', and
  89. `test-texinfo-3', is listed in this file after the line that says
  90. `Indirect:'.  The tag table is listed after the line that says `Tag
  91. table:'.
  92.    In the list of indirect files, the number following the file name
  93. records the cumulative number of bytes in the preceding indirect files,
  94. not counting the file list itself, the tag table, or the permissions
  95. text in each file.  In the tag table, the number following the node name
  96. records the location of the beginning of the node, in bytes from the
  97. beginning.
  98.    If you are using `texinfo-format-buffer' to create Info files, you
  99. may want to run the `Info-validate' command.  (The `makeinfo' command
  100. does such a good job on its own, you do not need `Info-validate'.)
  101. However, you cannot run the `M-x Info-validate' node-checking command
  102. on indirect files.  For information on how to prevent files from being
  103. split and how to validate the structure of the nodes, see *Note Using
  104. Info-validate::.
  105. File: texi.info,  Node: Install an Info File,  Next: Command List,  Prev: Create an Info File,  Up: Top
  106. Installing an Info File
  107. ***********************
  108.    Info files are usually kept in the `info' directory.  (You can find
  109. the location of this directory within Emacs by typing `C-h i' to enter
  110. Info and then typing `C-x C-f' to see the full pathname to the `info'
  111. directory.)
  112. * Menu:
  113. * Directory file::              The top level menu for all Info files.
  114. * New Info File::               Listing a new info file.
  115. * Other Info Directories::      How to specify Info files that are
  116.                                   located in other directories.
  117. File: texi.info,  Node: Directory file,  Next: New Info File,  Up: Install an Info File
  118. The `dir' File
  119. ==============
  120.    For Info to work, the `info' directory must contain a file that
  121. serves as a top level directory for the Info system.  By convention,
  122. this file is called `dir'.  The `dir' file is itself an Info file.  It
  123. contains the top level menu for all the Info files in the system.  The
  124. menu looks like this:
  125.      * Menu:
  126.      
  127.      * Info:    (info).     Documentation browsing system.
  128.      * Emacs:   (emacs).    The extensible, self-documenting
  129.                             text editor.
  130.      * Texinfo: (texinfo).  With one source file, make
  131.                             either a printed manual using
  132.                             TeX or an Info file.
  133.      ...
  134.    Each of these menu entries points to the `Top' node of the Info file
  135. that is named in parentheses.  (The menu entry does not need to specify
  136. the `Top' node, since Info goes to the `Top' node if no node name is
  137. mentioned.  *Note Nodes in Other Info Files: Other Info Files.)
  138.    Thus, the `Info' entry points to the `Top' node of the `info' file
  139. and the `Emacs' entry points to the `Top' node of the `emacs' file.
  140.    In each of the Info files, the `Up' pointer of the `Top' node refers
  141. back to the `dir' file.  For example, the line for the `Top' node of
  142. the Emacs manual looks like this in Info:
  143.      File: emacs  Node: Top, Up: (DIR), Next: Distrib
  144. (Note that in this case, the `dir' file name is written in upper case
  145. letters--it can be written in either upper or lower case.  Info has a
  146. feature that it will change the case of the file name to lower case if
  147. it cannot find the name as written.)
  148. File: texi.info,  Node: New Info File,  Next: Other Info Directories,  Prev: Directory file,  Up: Install an Info File
  149. Listing a New Info File
  150. =======================
  151.    To add a new Info file to your system, write a menu entry for it in
  152. the menu in the `dir' file in the `info' directory.  Also, move the new
  153. Info file itself to the `info' directory.  For example, if you were
  154. adding documentation for GDB, you would write the following new entry:
  155.      * GDB: (gdb).           The source-level C debugger.
  156. The first part of the menu entry is the menu entry name, followed by a
  157. colon.  The second part is the name of the Info file, in parentheses,
  158. followed by a period.  The third part is the description.
  159.    Conventionally, the name of an Info file has a `.info' extension.
  160. Thus, you might list the name of the file like this:
  161.      * GDB: (gdb.info).           The source-level C debugger.
  162. However, Info will look for a file with a `.info' extension if it does
  163. not find the file under the name given in the menu.  This means that
  164. you can refer to the file `gdb.info' as `gdb', as shown in the first
  165. example.  This looks better.
  166. File: texi.info,  Node: Other Info Directories,  Prev: New Info File,  Up: Install an Info File
  167. Info Files in Other Directories
  168. ===============================
  169.    If an Info file is not in the `info' directory, there are two ways
  170. to specify its location:
  171.    * Write the pathname as the menu's second part, or;
  172.    * Specify the `info' directory name in an environment variable in
  173.      your `.profile' or `.cshrc' initialization file.  (Only you and
  174.      others with the same environment variable will be able to find Info
  175.      files whose location is specified this way.)
  176.    For example, to reach a test file in the `~bob/manuals' directory,
  177. you could add an entry like this to the menu in the `dir' file:
  178.      * Test: (~bob/manuals/info-test).  Bob's own test file.
  179. In this case, the absolute file name of the `info-test' file is written
  180. as the second part of the menu entry.
  181.    Alternatively, you can tell Info where to look by setting the
  182. `INFOPATH' environment variable in your `.cshrc' or `.profile' file.
  183.    If you use `sh' or `bash' for your shell command interpreter, you
  184. must set the `INFOPATH' environment variable in the `.profile'
  185. initialization file; but if you use `csh', you must set the variable in
  186. the `.cshrc' initialization file.  The two files require slightly
  187. different command formats.
  188.    * In a `.cshrc' file, you could set the `INFOPATH' variable as
  189.      follows:
  190.           setenv INFOPATH .:~bob/manuals:/gnu/emacs/info
  191.    * In a `.profile' file, you would achieve the same effect by writing:
  192.           INFOPATH=.:~bob/manuals:/gnu/emacs/info
  193.           export INFOPATH
  194. Either form would cause Info to look first in the current directory,
  195. indicated by the `.', then in the `~bob/manuals' directory, and finally
  196. in the `/gnu/emacs/info' directory (which is a common location for the
  197. standard Info directory).
  198. File: texi.info,  Node: Command List,  Next: Tips,  Prev: Install an Info File,  Up: Top
  199. @-Command List
  200. **************
  201.    Here is an alphabetical list of the @-commands in Texinfo.  Square
  202. brackets, [ ], indicate optional arguments; an ellipsis, `...',
  203. indicates repeated text.
  204.      Force a line break. Do not end a paragraph that uses `@*' with an
  205.      `@refill' command.  *Note Line Breaks::.
  206.      Stands for a period that really does end a sentence (usually after
  207.      an end-of-sentence capital letter).  *Note Controlling Spacing::.
  208.      Indicate to TeX that an immediately preceding period, question
  209.      mark, exclamation mark, or colon does not end a sentence.  Prevent
  210.      TeX from inserting extra whitespace as it does at the end of a
  211.      sentence.  The command has no effect on the Info file output.
  212.      *Note Controlling Spacing::.
  213.      Stands for `@'.  *Note Inserting `@': Braces Atsigns Periods.
  214.      Stands for a left-hand brace, `{'.  *Note Inserting @ braces and
  215.      periods: Braces Atsigns Periods.
  216.      Stands for a right-hand brace, `}'.  *Note Inserting @ braces and
  217.      periods: Braces Atsigns Periods.
  218. `@appendix TITLE'
  219.      Begin an appendix.  The title appears in the table of contents of
  220.      a printed manual.  In Info, the title is underlined with
  221.      asterisks.  *Note The `@unnumbered' and `@appendix' Commands:
  222.      unnumbered & appendix.
  223. `@appendixsec TITLE'
  224. `@appendixsection TITLE'
  225.      Begin an appendix section within an appendix.  The section title
  226.      appears in the table of contents of a printed manual.  In Info,
  227.      the title is underlined with equal signs.  `@appendixsection' is a
  228.      longer spelling of the `@appendixsec' command.  *Note Section
  229.      Commands: unnumberedsec appendixsec heading.
  230. `@appendixsubsec TITLE'
  231.      Begin an appendix subsection within an appendix.  The title appears
  232.      in the table of contents of a printed manual.  In Info, the title
  233.      is underlined with hyphens.  *Note Subsection Commands:
  234.      unnumberedsubsec appendixsubsec subheading.
  235. `@appendixsubsubsec TITLE'
  236.      Begin an appendix subsubsection within a subappendix.  The title
  237.      appears in the table of contents of a printed manual.  In Info, the
  238.      title is underlined with periods.  *Note The `subsub' Commands:
  239.      subsubsection.
  240. `@asis'
  241.      Used following `@table', `@ftable', and `@vtable' to print the
  242.      table's first column without highlighting ("as is").  *Note Making
  243.      a Two-column Table: Two-column Tables.
  244. `@author AUTHOR'
  245.      Typeset AUTHOR flushleft and underline it.  *Note The `@title' and
  246.      `@author' Commands: title subtitle author.
  247. `@b{TEXT}'
  248.      Print TEXT in bold font.  No effect in Info.  *Note Fonts::.
  249. `@bullet{}'
  250.      Generate a large round dot, or the closest possible thing to one.
  251.      *Note `@bullet': bullet.
  252. `@bye'
  253.      Stop formatting a file.  The formatters do not see the contents of
  254.      a file following an `@bye' command.  *Note Ending a File::.
  255. `@c COMMENT'
  256.      Begin a comment in Texinfo.  The rest of the line does not appear
  257.      in either the Info file or the printed manual.  A synonym for
  258.      `@comment'.  *Note General Syntactic Conventions: Conventions.
  259. `@cartouche'
  260.      Highlight an example or quotation by drawing a box with rounded
  261.      corners around it.  Pair with `@end cartouche'.  No effect in
  262.      Info.  *Note Drawing Cartouches Around Examples: cartouche.)
  263. `@center LINE-OF-TEXT'
  264.      Center the line of text following the command.  *Note `@center':
  265.      titlefont center sp.
  266. `@chapheading TITLE'
  267.      Print a chapter-like heading in the text, but not in the table of
  268.      contents of a printed manual.  In Info, the title is underlined
  269.      with asterisks.  *Note `@majorheading' and `@chapheading':
  270.      majorheading & chapheading.
  271. `@chapter TITLE'
  272.      Begin a chapter.  The chapter title appears in the table of
  273.      contents of a printed manual.  In Info, the title is underlined
  274.      with asterisks.  *Note `@chapter': chapter.
  275. `@cindex ENTRY'
  276.      Add ENTRY to the index of concepts.  *Note Defining the Entries of
  277.      an Index: Index Entries.
  278. `@cite{REFERENCE}'
  279.      Highlight the name of a book or other reference that lacks a
  280.      companion Info file.  *Note `@cite': cite.
  281. `@clear FLAG'
  282.      Unset FLAG, preventing the Texinfo formatting commands from
  283.      formatting text between subsequent pairs of `@ifset FLAG' and
  284.      `@end ifset' commands, and preventing `@value{FLAG}' from
  285.      expanding to the value to which FLAG is set.  *Note `@set'
  286.      `@clear' `@value': set clear value.
  287. `@code{SAMPLE-CODE}'
  288.      Highlight text that is an expression, a syntactically complete
  289.      token of a program, or a program name.  *Note `@code': code.
  290. `@comment COMMENT'
  291.      Begin a comment in Texinfo.  The rest of the line does not appear
  292.      in either the Info file or the printed manual.  A synonym for `@c'.
  293.      *Note General Syntactic Conventions: Conventions.
  294. `@contents'
  295.      Print a complete table of contents.  Has no effect in Info, which
  296.      uses menus instead.  *Note Generating a Table of Contents:
  297.      Contents.
  298. `@copyright{}'
  299.      Generate a copyright symbol.  *Note `@copyright': copyright symbol.
  300. `@defcodeindex INDEX-NAME'
  301.      Define a new index and its indexing command.  Print entries in an
  302.      `@code' font.  *Note Defining New Indices: New Indices.
  303. `@defcv CATEGORY CLASS NAME'
  304.      Format a description for a variable associated with a class in
  305.      object-oriented programming.  Takes three arguments: the category
  306.      of thing being defined, the class to which it belongs, and its
  307.      name.  *Note Definition Commands::.
  308. `@deffn CATEGORY NAME ARGUMENTS...'
  309.      Format a description for a function, interactive command, or
  310.      similar entity that may take arguments.  `@deffn' takes as
  311.      arguments the category of entity being described, the name of this
  312.      particular entity, and its arguments, if any.  *Note Definition
  313.      Commands::.
  314. `@defindex INDEX-NAME'
  315.      Define a new index and its indexing command.  Print entries in a
  316.      roman font.  *Note Defining New Indices: New Indices.
  317. `@defivar CLASS INSTANCE-VARIABLE-NAME'
  318.      Format a description for an instance variable in object-oriented
  319.      programming.  The command is equivalent to `@defcv {Instance
  320.      Variable} ...'.  *Note Definition Commands::.
  321. `@defmac MACRO-NAME ARGUMENTS...'
  322.      Format a description for a macro.  The command is equivalent to
  323.      `@deffn Macro ...'.  *Note Definition Commands::.
  324. `@defmethod CLASS METHOD-NAME ARGUMENTS...'
  325.      Format a description for a method in object-oriented programming.
  326.      The command is equivalent to `@defop Method ...'.  Takes as
  327.      arguments the name of the class of the method, the name of the
  328.      method, and its arguments, if any.  *Note Definition Commands::.
  329. `@defop CATEGORY CLASS NAME ARGUMENTS...'
  330.      Format a description for an operation in object-oriented
  331.      programming.  `@defop' takes as arguments the overall name of the
  332.      category of operation, the name of the class of the operation, the
  333.      name of the operation, and its arguments, if any.  *Note
  334.      Definition Commands::.
  335. `@defopt OPTION-NAME'
  336.      Format a description for a user option.  The command is equivalent
  337.      to `@defvr {User Option} ...'.  *Note Definition Commands::.
  338. `@defspec SPECIAL-FORM-NAME ARGUMENTS...'
  339.      Format a description for a special form.  The command is
  340.      equivalent to `@deffn {Special Form} ...'.  *Note Definition
  341.      Commands::.
  342. `@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...'
  343.      Format a description for a data type.  `@deftp' takes as arguments
  344.      the category, the name of the type (which is a word like `int' or
  345.      `float'), and then the names of attributes of objects of that
  346.      type.  *Note Definition Commands::.
  347. `@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
  348.      Format a description for a function or similar entity that may take
  349.      arguments and that is typed.  `@deftypefn' takes as arguments the
  350.      classification of entity being described, the type, the name of
  351.      the entity, and its arguments, if any.  *Note Definition
  352.      Commands::.
  353. `@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...'
  354.      Format a description for a function in a typed language.  The
  355.      command is equivalent to `@deftypefn Function ...'.  *Note
  356.      Definition Commands::.
  357. `@deftypevr CLASSIFICATION DATA-TYPE NAME'
  358.      Format a description for something like a variable in a typed
  359.      language--an entity that records a value.  Takes as arguments the
  360.      classification of entity being described, the type, and the name of
  361.      the entity.  *Note Definition Commands::.
  362. `@deftypevar DATA-TYPE VARIABLE-NAME'
  363.      Format a description for a variable in a typed language.  The
  364.      command is equivalent to `@deftypevr Variable ...'.  *Note
  365.      Definition Commands::.
  366. `@defun FUNCTION-NAME ARGUMENTS...'
  367.      Format a description for functions.  The command is equivalent to
  368.      `@deffn Function ...'.  *Note Definition Commands::.
  369. `@defvar VARIABLE-NAME'
  370.      Format a description for variables.  The command is equivalent to
  371.      `@defvr Variable ...'.  *Note Definition Commands::.
  372. `@defvr CATEGORY NAME'
  373.      Format a description for any kind of variable.  `@defvr' takes as
  374.      arguments the category of the entity and the name of the entity.
  375.      *Note Definition Commands::.
  376. `@dfn{TERM}'
  377.      Highlight the introductory or defining use of a term.  *Note
  378.      `@dfn': dfn.
  379. `@display'
  380.      Begin a kind of example.  Indent text, do not fill, do not select a
  381.      new font.  Pair with `@end display'.  *Note `@display': display.
  382. `@dmn{DIMENSION}'
  383.      Format a dimension.  Cause TeX to insert a narrow space before
  384.      DIMENSION.  No effect in Info.  Use for writing a number followed
  385.      by an abbreviation of a dimension name, such as `12pt', written as
  386.      `12@dmn{pt}', with no space between the number and the `@dmn'
  387.      command.  *Note `@dmn': dmn.
  388. `@dots{}'
  389.      Insert an ellipsis: `...'.  *Note `@dots': dots.
  390. `@emph{TEXT}'
  391.      Highlight TEXT; text is displayed in *italics* in printed output,
  392.      and surrounded by asterisks in Info.  *Note Emphasizing Text:
  393.      Emphasis.
  394. `@enumerate [NUMBER-OR-LETTER]'
  395.      Begin a numbered list, using `@item' for each entry.  Optionally,
  396.      start list with NUMBER-OR-LETTER.  Pair with `@end enumerate'.
  397.      *Note `@enumerate': enumerate.
  398. `@equiv{}'
  399.      Indicate to the reader the exact equivalence of two forms with a
  400.      glyph: `=='.  *Note Equivalence::.
  401. `@error{}'
  402.      Indicate to the reader with a glyph that the following text is an
  403.      error message: `error-->'.  *Note Error Glyph::.
  404. `@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
  405.      Specify page footings for even-numbered (left-hand) pages.  Not
  406.      relevant to Info.  *Note How to Make Your Own Headings: Custom
  407.      Headings.
  408. `@evenheading [LEFT] @| [CENTER] @| [RIGHT]'
  409.      Specify page headings for even-numbered (left-hand) pages.  Not
  410.      relevant to Info.  *Note How to Make Your Own Headings: Custom
  411.      Headings.
  412. `@everyfooting [LEFT] @| [CENTER] @| [RIGHT]'
  413.      Specify page footings for every page.  Not relevant to Info.
  414.      *Note How to Make Your Own Headings: Custom Headings.
  415. `@everyheading [LEFT] @| [CENTER] @| [RIGHT]'
  416.      Specify page headings for every page.  Not relevant to Info.
  417.      *Note How to Make Your Own Headings: Custom Headings.
  418. `@example'
  419.      Begin an example.  Indent text, do not fill, and select
  420.      fixed-width font.  Pair with `@end example'.  *Note `@example':
  421.      example.
  422. `@exdent LINE-OF-TEXT'
  423.      Remove any indentation a line might have.  *Note Undoing the
  424.      Indentation of a Line: exdent.
  425. `@expansion{}'
  426.      Indicate the result of a macro expansion to the reader with a
  427.      special glyph: `==>'.  *Note ==> Indicating an Expansion:
  428.      expansion.
  429. `@file{FILENAME}'
  430.      Highlight the name of a file, buffer, node, or directory.  *Note
  431.      `@file': file.
  432. `@finalout'
  433.      Prevent TeX from printing large black warning rectangles beside
  434.      over-wide lines.  *Note Overfull hboxes::.
  435. `@findex ENTRY'
  436.      Add ENTRY to the index of functions.  *Note Defining the Entries
  437.      of an Index: Index Entries.
  438. `@flushleft'
  439.      Left justify every line but leave the right end ragged.  Leave
  440.      font as is.  Pair with `@end flushleft'.  *Note `@flushleft' and
  441.      `@flushright': flushleft & flushright.
  442. `@flushright'
  443.      Right justify every line but leave the left end ragged.  Leave
  444.      font as is.  Pair with `@end flushright'.  *Note `@flushleft' and
  445.      `@flushright': flushleft & flushright.
  446. `@footnote{TEXT-OF-FOOTNOTE}'
  447.      Enter a footnote.  Footnote text is printed at the bottom of the
  448.      page by TeX; Info may format in either `End' node or `Separate'
  449.      node style.  *Note Footnotes::.
  450. `@footnotestyle STYLE'
  451.      Specify an Info file's footnote style, either `end' for the end
  452.      node style or `separate' for the separate node style.  *Note
  453.      Footnotes::.
  454. `@format'
  455.      Begin a kind of example.  Like `@example' or `@display', but do
  456.      not narrow the margins and do not select the fixed-width font.
  457.      Pair with `@end format'.  *Note `@example': example.
  458. `@ftable FORMATTING-COMMAND'
  459.      Begin a two-column table, using `@item' for each entry.
  460.      Automatically enter each of the items in the first column into the
  461.      index of functions.  Pair with `@end ftable'.  The same as
  462.      `@table', except for indexing.  *Note `@ftable' and `@vtable':
  463.      ftable vtable.
  464. `@group'
  465.      Hold text together that must appear on one printed page.  Pair with
  466.      `@end group'.  Not relevant to Info.  *Note `@group': group.
  467. `@heading TITLE'
  468.      Print an unnumbered section-like heading in the text, but not in
  469.      the table of contents of a printed manual.  In Info, the title is
  470.      underlined with equal signs.  *Note Section Commands:
  471.      unnumberedsec appendixsec heading.
  472. `@headings ON-OFF-SINGLE-DOUBLE'
  473.      Turn page headings on or off, or specify single-sided or
  474.      double-sided page headings for printing.  `@headings on' is
  475.      synonymous with `@headings double'.  *Note The `@headings'
  476.      Command: headings on off.
  477. `@i{TEXT}'
  478.      Print TEXT in italic font.  No effect in Info.  *Note Fonts::.
  479. `@ifclear FLAG'
  480.      If FLAG is cleared, the Texinfo formatting commands format text
  481.      between `@ifclear FLAG' and the following `@end ifclear' command.
  482.      *Note `@set' `@clear' `@value': set clear value.
  483. `@ifinfo'
  484.      Begin a stretch of text that will be ignored by TeX when it
  485.      typesets the printed manual.  The text appears only in the Info
  486.      file.  Pair with `@end ifinfo'.  *Note Conditionally Visible Text:
  487.      Conditionals.
  488. `@ifset FLAG'
  489.      If FLAG is set, the Texinfo formatting commands format text
  490.      between `@ifset FLAG' and the following `@end ifset' command.
  491.      *Note `@set' `@clear' `@value': set clear value.
  492. `@iftex'
  493.      Begin a stretch of text that will not appear in the Info file, but
  494.      will be processed only by TeX.  Pair with `@end iftex'.  *Note
  495.      Conditionally Visible Text: Conditionals.
  496. `@ignore'
  497.      Begin a stretch of text that will not appear in either the Info
  498.      file or the printed output.  Pair with `@end ignore'.  *Note
  499.      Comments and Ignored Text: Comments.
  500. `@include FILENAME'
  501.      Incorporate the contents of the file FILENAME into the Info file
  502.      or printed document.  *Note Include Files::.
  503. `@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}'
  504.      Make a cross reference to an Info file for which there is no
  505.      printed manual.  *Note Cross references using `@inforef': inforef.
  506. `\input MACRO-DEFINITIONS-FILE'
  507.      Use the specified macro definitions file.  This command is used
  508.      only in the first line of a Texinfo file to cause TeX to make use
  509.      of the `texinfo' macro definitions file.  The backslash in `\input'
  510.      is used instead of an `@' because TeX does not properly recognize
  511.      `@' until after it has read the definitions file.  *Note The
  512.      Texinfo File Header: Header.
  513. `@item'
  514.      Indicate the beginning of a marked paragraph for `@itemize' and
  515.      `@enumerate'; indicate the beginning of the text of a first column
  516.      entry for `@table', `@ftable', and `@vtable'.  *Note Lists and
  517.      Tables::.
  518. `@itemize  MARK-GENERATING-CHARACTER-OR-COMMAND'
  519.      Produce a sequence of indented paragraphs, with a mark inside the
  520.      left margin at the beginning of each paragraph.  Pair with `@end
  521.      itemize'.  *Note `@itemize': itemize.
  522. `@itemx'
  523.      Like `@item' but do not generate extra vertical space above the
  524.      item text.  *Note `@itemx': itemx.
  525. `@kbd{KEYBOARD-CHARACTERS}'
  526.      Indicate text that consists of characters of input to be typed by
  527.      users.  *Note `@kbd': kbd.
  528. `@key{KEY-NAME}'
  529.      Highlight KEY-NAME, a conventional name for a key on a keyboard.
  530.      *Note `@key': key.
  531. `@kindex ENTRY'
  532.      Add ENTRY to the index of keys.  *Note Defining the Entries of an
  533.      Index: Index Entries.
  534. `@lisp'
  535.      Begin an example of Lisp code.  Indent text, do not fill, and
  536.      select fixed-width font.  Pair with `@end lisp'.  *Note `@lisp':
  537.      Lisp Example.
  538. `@majorheading  TITLE'
  539.      Print a chapter-like heading in the text, but not in the table of
  540.      contents of a printed manual.  Generate more vertical whitespace
  541.      before the heading than the `@chapheading' command.  In Info, the
  542.      chapter heading line is underlined with asterisks.  *Note
  543.      `@majorheading' and `@chapheading': majorheading & chapheading.
  544. `@menu'
  545.      Mark the beginning of a menu of nodes in Info.  No effect in a
  546.      printed manual.  Pair with `@end menu'.  *Note Menus::.
  547. `@minus{}'
  548.      Generate a minus sign.  *Note `@minus': minus.
  549. `@need N'
  550.      Start a new page in a printed manual if fewer than N mils
  551.      (thousandths of an inch) remain on the current page.  *Note
  552.      `@need': need.
  553. `@node NAME, NEXT, PREVIOUS, UP'
  554.      Define the beginning of a new node in Info, and serve as a locator
  555.      for references for TeX.  *Note `@node': node.
  556. `@noindent'
  557.      Prevent text from being indented as if it were a new paragraph.
  558.      *Note `@noindent': noindent.
  559. `@oddfooting [LEFT] @| [CENTER] @| [RIGHT]'
  560.      Specify page footings for odd-numbered (right-hand) pages.  Not
  561.      relevant to Info.  *Note How to Make Your Own Headings: Custom
  562.      Headings.
  563. `@oddheading [LEFT] @| [CENTER] @| [RIGHT]'
  564.      Specify page headings for odd-numbered (right-hand) pages.  Not
  565.      relevant to Info.  *Note How to Make Your Own Headings: Custom
  566.      Headings.
  567. `@page'
  568.      Start a new page in a printed manual.  No effect in Info.  *Note
  569.      `@page': page.
  570. `@paragraphindent INDENT'
  571.      Indent paragraphs by INDENT number of spaces; delete indentation
  572.      if the value of INDENT is 0; and do not change indentation if
  573.      INDENT is `asis'. *Note Paragraph Indenting: paragraphindent.
  574. `@pindex ENTRY'
  575.      Add ENTRY to the index of programs.  *Note Defining the Entries of
  576.      an Index: Index Entries.
  577. `@point{}'
  578.      Indicate the position of point in a buffer to the reader with a
  579.      glyph: `-!-'.  *Note Indicating Point in a Buffer: Point Glyph.
  580. `@print{}'
  581.      Indicate printed output to the reader with a glyph: `-|'.  *Note
  582.      Print Glyph::.
  583. `@printindex INDEX-NAME'
  584.      Print an alphabetized two-column index in a printed manual or
  585.      generate an alphabetized menu of index entries for Info.  *Note
  586.      Printing Indices & Menus::.
  587. `@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
  588.      Make a reference that starts with a lower case `see' in a printed
  589.      manual.  Use within parentheses only.  Do not follow command with a
  590.      punctuation mark.  The Info formatting commands automatically
  591.      insert terminating punctuation as needed, which is why you do not
  592.      need to insert punctuation.  Only the first argument is mandatory.
  593.      *Note `@pxref': pxref.
  594. `@quotation'
  595.      Narrow the margins to indicate text that is quoted from another
  596.      real or imaginary work.  Write command on a line of its own.  Pair
  597.      with `@end quotation'.  *Note `@quotation': quotation.
  598. `@r{TEXT}'
  599.      Print TEXT in roman font.  No effect in Info.  *Note Fonts::.
  600. `@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
  601.      Make a reference.  In a printed manual, the reference does not
  602.      start with a `See'.  Follow command with a punctuation mark.  Only
  603.      the first argument is mandatory.  *Note `@ref': ref.
  604. `@refill'
  605.      In Info, refill and indent the paragraph after all the other
  606.      processing has been done.  No effect on TeX, which always refills.
  607.      This command is no longer needed, since all formatters now
  608.      automatically refill.  *Note Refilling Paragraphs::.
  609. `@result{}'
  610.      Indicate the result of an expression to the reader with a special
  611.      glyph: `=>'.  *Note `@result': result.
  612. `@samp{TEXT}'
  613.      Highlight TEXT that is a literal example of a sequence of
  614.      characters.  Used for single characters, for statements, and often
  615.      for entire shell commands.  *Note `@samp': samp.
  616. `@sc{TEXT}'
  617.      Set TEXT in a printed output in THE SMALL CAPS FONT and set text
  618.      in the Info file in uppercase letters.  *Note Smallcaps::.
  619. `@section TITLE'
  620.      Begin a section within a chapter.  In a printed manual, the section
  621.      title is numbered and appears in the table of contents.  In Info,
  622.      the title is underlined with equal signs.  *Note `@section':
  623.      section.
  624. `@set FLAG [STRING]'
  625.      Make FLAG active, causing the Texinfo formatting commands to
  626.      format text between subsequent pairs of `@ifset FLAG' and `@end
  627.      ifset' commands.  Optionally, set value of FLAG to STRING.  *Note
  628.      `@set' `@clear' `@value': set clear value.
  629. `@setchapternewpage ON-OFF-ODD'
  630.      Specify whether chapters start on new pages, and if so, whether on
  631.      odd-numbered (right-hand) new pages.  *Note `@setchapternewpage':
  632.      setchapternewpage.
  633. `@setfilename INFO-FILE-NAME'
  634.      Provide a name for the Info file.  *Note General Syntactic
  635.      Conventions: Conventions.
  636. `@settitle TITLE'
  637.      Provide a title for page headers in a printed manual.  *Note
  638.      General Syntactic Conventions: Conventions.
  639. `@shortcontents'
  640.      Print a short table of contents.  Not relevant to Info, which uses
  641.      menus rather than tables of contents.  A synonym for
  642.      `@summarycontents'.  *Note Generating a Table of Contents:
  643.      Contents.
  644. `@smallbook'
  645.      Cause TeX to produce a printed manual in a 7 by 9.25 inch format
  646.      rather than the regular 8.5 by 11 inch format.  *Note Printing
  647.      Small Books: smallbook.  Also, see *Note `@smallexample' and
  648.      `@smalllisp': smallexample & smalllisp.
  649. `@smallexample'
  650.      Indent text to indicate an example.  Do not fill, select
  651.      fixed-width font.  In `@smallbook' format, print text in a smaller
  652.      font than with `@example'.  Pair with `@end smallexample'.  *Note
  653.      `@smallexample' and `@smalllisp': smallexample & smalllisp.
  654. `@smalllisp'
  655.      Begin an example of Lisp code.  Indent text, do not fill, select
  656.      fixed-width font.  In `@smallbook' format, print text in a smaller
  657.      font.  Pair with `@end smalllisp'.  *Note `@smallexample' and
  658.      `@smalllisp': smallexample & smalllisp.
  659. `@sp N'
  660.      Skip N blank lines.  *Note `@sp': sp.
  661. `@strong TEXT'
  662.      Emphasize TEXT by typesetting it in a *bold* font for the printed
  663.      manual and by surrounding it with asterisks for Info.  *Note
  664.      Emphasizing Text: emph & strong.
  665. `@subheading TITLE'
  666.      Print an unnumbered subsection-like heading in the text, but not in
  667.      the table of contents of a printed manual.  In Info, the title is
  668.      underlined with hyphens.  *Note `@unnumberedsubsec'
  669.      `@appendixsubsec' `@subheading': unnumberedsubsec appendixsubsec
  670.      subheading.
  671. `@subsection TITLE'
  672.      Begin a subsection within a section.  In a printed manual, the
  673.      subsection title is numbered and appears in the table of contents.
  674.      In Info, the title is underlined with hyphens.  *Note
  675.      `@subsection': subsection.
  676. `@subsubheading TITLE'
  677.      Print an unnumbered subsubsection-like heading in the text, but
  678.      not in the table of contents of a printed manual.  In Info, the
  679.      title is underlined with periods.  *Note The `subsub' Commands:
  680.      subsubsection.
  681. `@subsubsection TITLE'
  682.      Begin a subsubsection within a subsection.  In a printed manual,
  683.      the subsubsection title is numbered and appears in the table of
  684.      contents.  In Info, the title is underlined with periods.  *Note
  685.      The `subsub' Commands: subsubsection.
  686. `@subtitle TITLE'
  687.      In a printed manual, set a subtitle in a normal sized font flush to
  688.      the right-hand side of the page.  Not relevant to Info, which does
  689.      not have title pages.  *Note `@title' `@subtitle' and `@author'
  690.      Commands: title subtitle author.
  691. `@summarycontents'
  692.      Print a short table of contents.  Not relevant to Info, which uses
  693.      menus rather than tables of contents.  A synonym for
  694.      `@shortcontents'.  *Note Generating a Table of Contents: Contents.
  695. `@syncodeindex FROM-INDEX INTO-INDEX'
  696.      Merge the index named in the first argument into the index named in
  697.      the second argument, printing the entries from the first index in
  698.      `@code' font.  *Note Combining Indices::.
  699. `@synindex FROM-INDEX INTO-INDEX'
  700.      Merge the index named in the first argument into the index named in
  701.      the second argument.  Do not change the font of FROM-INDEX
  702.      entries.  *Note Combining Indices::.
  703. `@t{TEXT}'
  704.      Print TEXT in a fixed-width, typewriter-like font.  No effect in
  705.      Info.  *Note Fonts::.
  706. `@table FORMATTING-COMMAND'
  707.      Begin a two-column table, using `@item' for each entry.  Write
  708.      each first column entry on the same line as `@item'.  First column
  709.      entries are printed in the font resulting from FORMATTING-COMMAND.
  710.      Pair with `@end table'.  *Note Making a Two-column Table:
  711.      Two-column Tables.  Also see *Note `@ftable' and `@vtable': ftable
  712.      vtable, and *Note `@itemx': itemx.
  713. `@TeX{}'
  714.      Insert the logo TeX.  *Note Inserting TeX and (C): TeX and
  715.      copyright.
  716. `@tex'
  717.      Enter TeX completely.  Pair with `@end tex'.  *Note Using Ordinary
  718.      TeX Commands: Using Ordinary TeX Commands.
  719. `@thischapter'
  720.      In a heading or footing, stands for the number and name of the
  721.      current chapter, in the format `Chapter 1: Title'.  *Note How to
  722.      Make Your Own Headings: Custom Headings.
  723. `@thischaptername'
  724.      In a heading or footing, stands for the name of the current
  725.      chapter.  *Note How to Make Your Own Headings: Custom Headings.
  726. `@thisfile'
  727.      In a heading or footing, stands for the name of the current
  728.      `@include' file.  Does not insert anything if not within an
  729.      `@include' file.  *Note How to Make Your Own Headings: Custom
  730.      Headings.
  731. `@thispage'
  732.      In a heading or footing, stands for the current page number.
  733.      *Note How to Make Your Own Headings: Custom Headings.
  734. `@thistitle'
  735.      In a heading or footing, stands for the name of the document, as
  736.      specified by the `@settitle' command.  *Note How to Make Your Own
  737.      Headings: Custom Headings.
  738. `@tindex ENTRY'
  739.      Add ENTRY to the index of data types.  *Note Defining the Entries
  740.      of an Index: Index Entries.
  741. `@title TITLE'
  742.      In a printed manual, set a title flush to the left-hand side of the
  743.      page in a larger than normal font and underline it with a black
  744.      rule.  Not relevant to Info, which does not have title pages.
  745.      *Note The `@title' `@subtitle' and `@author' Commands: title
  746.      subtitle author.
  747. `@titlefont{TEXT}'
  748.      In a printed manual, print TEXT in a larger than normal font.  Not
  749.      relevant to Info, which does not have title pages.  *Note The
  750.      `@titlefont' `@center' and `@sp' Commands: titlefont center sp.
  751. `@titlepage'
  752.      Indicate to Texinfo the beginning of the title page.  Write
  753.      command on a line of its own.  Pair with `@end titlepage'.
  754.      Nothing between `@titlepage' and `@end titlepage' appears in Info.
  755.      *Note `@titlepage': titlepage.
  756. `@today{}'
  757.      Insert the current date, in `1 Jan 1900' style.  *Note How to Make
  758.      Your Own Headings: Custom Headings.
  759. `@top TITLE'
  760.      In a Texinfo file to be formatted with `makeinfo', identify the
  761.      topmost `@node' line in the file, which must be written on the line
  762.      immediately preceding the `@top' command.  Used for `makeinfo''s
  763.      node pointer insertion feature.  The title is underlined with
  764.      asterisks.  Both the `@node' line and the `@top' line normally
  765.      should be enclosed by `@ifinfo' and `@end ifinfo'.  In TeX and
  766.      `texinfo-format-buffer', the `@top' command is merely a synonym
  767.      for `@unnumbered'.  *Note Creating Pointers with `makeinfo':
  768.      makeinfo Pointer Creation.
  769. `@unnumbered TITLE'
  770.      In a printed manual, begin a chapter that appears without chapter
  771.      numbers of any kind.  The title appears in the table of contents
  772.      of a printed manual.  In Info, the title is underlined with
  773.      asterisks.  *Note `@unnumbered' and `@appendix': unnumbered &
  774.      appendix.
  775. `@unnumberedsec TITLE'
  776.      In a printed manual, begin a section that appears without section
  777.      numbers of any kind.  The title appears in the table of contents
  778.      of a printed manual.  In Info, the title is underlined with equal
  779.      signs.  *Note Section Commands: unnumberedsec appendixsec heading.
  780. `@unnumberedsubsec TITLE'
  781.      In a printed manual, begin an unnumbered subsection within a
  782.      chapter.  The title appears in the table of contents of a printed
  783.      manual.  In Info, the title is underlined with hyphens.  *Note
  784.      `@unnumberedsubsec' `@appendixsubsec' `@subheading':
  785.      unnumberedsubsec appendixsubsec subheading.
  786. `@unnumberedsubsubsec TITLE'
  787.      In a printed manual, begin an unnumbered subsubsection within a
  788.      chapter.  The title appears in the table of contents of a printed
  789.      manual.  In Info, the title is underlined with periods.  *Note The
  790.      `subsub' Commands: subsubsection.
  791. `@value{FLAG}'
  792.      Replace FLAG with the value to which it is set by `@set FLAG'.
  793.      *Note `@set' `@clear' `@value': set clear value.
  794. `@var{METASYNTACTIC-VARIABLE}'
  795.      Highlight a metasyntactic variable, which is something that stands
  796.      for another piece of text.  *Note Indicating Metasyntactic
  797.      Variables: var.
  798. `@vindex ENTRY'
  799.      Add ENTRY to the index of variables.  *Note Defining the Entries
  800.      of an Index: Index Entries.
  801. `@vskip AMOUNT'
  802.      In a printed manual, insert whitespace so as to push text on the
  803.      remainder of the page towards the bottom of the page.  Used in
  804.      formatting the copyright page with the argument `0pt plus 1filll'.
  805.      (Note spelling of `filll'.)  `@vskip' may be used only in
  806.      contexts ignored for Info.  *Note The Copyright Page and Printed
  807.      Permissions: Copyright & Permissions.
  808. `@vtable FORMATTING-COMMAND'
  809.      Begin a two-column table, using `@item' for each entry.
  810.      Automatically enter each of the items in the first column into the
  811.      index of variables.  Pair with `@end vtable'.  The same as
  812.      `@table', except for indexing.  *Note `@ftable' and `@vtable':
  813.      ftable vtable.
  814. `@w{TEXT}'
  815.      Prevent TEXT from being split across two lines.  Do not end a
  816.      paragraph that uses `@w' with an `@refill' command.  In the
  817.      Texinfo file, keep TEXT on one line.  *Note `@w': w.
  818. `@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
  819.      Make a reference that starts with `See' in a printed manual.
  820.      Follow command with a punctuation mark.  Only the first argument is
  821.      mandatory.  *Note `@xref': xref.
  822.