home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / gnu / texinfo-3.1-bin.lha / info / texi.info-4 < prev    next >
Encoding:
GNU Info File  |  1994-02-24  |  48.3 KB  |  1,413 lines
  1. This is Info file texi.info, produced by Makeinfo-1.55 from the input
  2. file texi.texi.
  3.  
  4.    This file documents Texinfo, a documentation system that uses a
  5. single source file to produce both on-line information and a printed
  6. manual.
  7.  
  8.    Copyright (C) 1988, 1990, 1991, 1992, 1993 Free Software Foundation,
  9. Inc.
  10.  
  11.    This is the second edition of the Texinfo documentation,
  12. and is consistent with version 2 of `texinfo.tex'.
  13.  
  14.    Permission is granted to make and distribute verbatim copies of this
  15. manual provided the copyright notice and this permission notice are
  16. preserved on all copies.
  17.  
  18.    Permission is granted to copy and distribute modified versions of
  19. this manual under the conditions for verbatim copying, provided that
  20. the entire resulting derived work is distributed under the terms of a
  21. permission notice identical to this one.
  22.  
  23.    Permission is granted to copy and distribute translations of this
  24. manual into another language, under the above conditions for modified
  25. versions, except that this permission notice may be stated in a
  26. translation approved by the Free Software Foundation.
  27.  
  28. 
  29. File: texi.info,  Node: Node Line Requirements,  Next: First Node,  Prev: Node Line Tips,  Up: node
  30.  
  31. `@node' Line Requirements
  32. -------------------------
  33.  
  34.    Here are several requirements for `@node' lines:
  35.  
  36.    * All the node names for a single Info file must be unique.
  37.  
  38.      Duplicates confuse the Info movement commands.  This means, for
  39.      example, that if you end every chapter with a summary, you must
  40.      name each summary node differently.  You cannot just call each one
  41.      "Summary".  You may, however, duplicate the titles of chapters,
  42.      sections, and the like.  Thus you can end each chapter in a book
  43.      with a section called "Summary", so long as the node names for
  44.      those sections are all different.
  45.  
  46.    * A pointer name must be the name of a node.
  47.  
  48.      The node to which a pointer points may come before or after the
  49.      node containing the pointer.
  50.  
  51.    * You cannot use any of the Texinfo @-commands in a node name;
  52.      @-commands confuse Info.
  53.  
  54.      Thus, the beginning of the section called `@chapter' looks like
  55.      this:
  56.  
  57.           @node  chapter, unnumbered & appendix, makeinfo top, Structuring
  58.           @comment  node-name,  next,  previous,  up
  59.           @section @code{@@chapter}
  60.           @findex chapter
  61.  
  62.    * You cannot use commas, colons, or apostrophes within a node name;
  63.      these confuse TeX or the Info formatters.
  64.  
  65.      For example, the following is a section title:
  66.  
  67.           @code{@@unnumberedsec}, @code{@@appendixsec}, @code{@@heading}
  68.  
  69.      The corresponding node name is:
  70.  
  71.           unnumberedsec appendixsec heading
  72.  
  73.    * Case is significant.
  74.  
  75. 
  76. File: texi.info,  Node: First Node,  Next: makeinfo top command,  Prev: Node Line Requirements,  Up: node
  77.  
  78. The First Node
  79. --------------
  80.  
  81.    The first node of a Texinfo file is the `Top' node, except in an
  82. included file (*note Include Files::.).
  83.  
  84.    The `Top' node (which must be named `top' or `Top') should have as
  85. its `Up' and `Previous' nodes the name of a node in another file, where
  86. there is a menu that leads to this file.  Specify the file name in
  87. parentheses.  If the file is to be installed directly in the Info
  88. directory file, use `(dir)' as the parent of the `Top' node; this is
  89. short for `(dir)top', and specifies the `Top' node in the `dir' file,
  90. which contains the main menu for Info.  For example, the `@node Top'
  91. line of this manual looks like this:
  92.  
  93.      @node Top, Overview, (dir), (dir)
  94.  
  95. (You may use the Texinfo updating commands or the `makeinfo' utility to
  96. insert these `Next' and `(dir)' pointers automatically.)
  97.  
  98.    *Note Install an Info File::, for more information about installing
  99. an Info file in the `info' directory.
  100.  
  101.    The `Top' node contains the main or master menu for the document.
  102.  
  103. 
  104. File: texi.info,  Node: makeinfo top command,  Next: Top Node Summary,  Prev: First Node,  Up: node
  105.  
  106. The `@top' Sectioning Command
  107. -----------------------------
  108.  
  109.    A special sectioning command, `@top', has been created for use with
  110. the `@node Top' line.  The `@top' sectioning command tells `makeinfo'
  111. that it marks the `Top' node in the file.  It provides the information
  112. that `makeinfo' needs to insert node pointers automatically.  Write the
  113. `@top' command at the beginning of the line immediately following the
  114. `@node Top' line.  Write the title on the remaining part of the same
  115. line as the `@top' command.
  116.  
  117.    In Info, the `@top' sectioning command causes the title to appear on
  118. a line by itself, with a line of asterisks inserted underneath.
  119.  
  120.    In TeX and `texinfo-format-buffer', the `@top' sectioning command is
  121. merely a synonym for `@unnumbered'.  Neither of these formatters
  122. require an `@top' command, and do nothing special with it.  You can use
  123. `@chapter' or `@unnumbered' after the `@node Top' line when you use
  124. these formatters.  Also, you can use `@chapter' or `@unnumbered' when
  125. you use the Texinfo updating commands to create or update pointers and
  126. menus.
  127.  
  128.    Whatever sectioning command follows an `@node Top' line, whether it
  129. be `@top' or `@chapter', the `@node Top' line and the immediately
  130. following line and any additional text must be enclosed between
  131. `@ifinfo' and `@end ifinfo' commands.  (*Note Conditionals::.)  This
  132. prevents the title and the accompanying text from appearing in printed
  133. output.  Write the `@ifinfo' command before the `@node' line and write
  134. the `@end ifinfo' command after the `@top' or other sectioning command
  135. and after any additional text.  (You can write the `@end ifinfo'
  136. command after the `@end menu' command if you like.)
  137.  
  138. 
  139. File: texi.info,  Node: Top Node Summary,  Prev: makeinfo top command,  Up: node
  140.  
  141. The `Top' Node Summary
  142. ----------------------
  143.  
  144.    You can help readers by writing a summary in the `Top' node, after
  145. the `@top' line, before the main or master menu.  The summary should
  146. briefly describe the Info file.  You should also write the version
  147. number of the program to which the manual applies in this section.  This
  148. helps the reader keep track of which manual is for which version of the
  149. program.  If the manual changes more frequently than the program or is
  150. independent of it, you should also include an edition number for the
  151. manual.  (The title page should also contain this information: see
  152. *Note `@titlepage': titlepage.)
  153.  
  154.    Put the whole of the `Top' node, including the `@top' sectioning
  155. command line if you have one, between `@ifinfo' and `@end ifinfo' so
  156. none of the text appears in the printed output (*note Conditionally
  157. Visible Text: Conditionals.).  (You may want to repeat the brief
  158. description from the `Top' node within `@iftex' ... `@end iftex' at the
  159. beginning of the first chapter, for those who read the printed manual.)
  160.  
  161. 
  162. File: texi.info,  Node: makeinfo Pointer Creation,  Prev: node,  Up: Nodes
  163.  
  164. Creating Pointers with `makeinfo'
  165. =================================
  166.  
  167.    The `makeinfo' program has a feature for automatically creating node
  168. pointers for a hierarchically organized file that lacks them.
  169.  
  170.    When you take advantage of this feature, you do not need to write the
  171. `Next', `Previous', and `Up' pointers after the name of a node.
  172. However, you must write a sectioning command, such as `@chapter' or
  173. `@section', on the line immediately following each truncated `@node'
  174. line.  You cannot write a comment line after a node line; the section
  175. line must follow it immediately.
  176.  
  177.    In addition, you must follow the `Top' `@node' line with a line
  178. beginning with `@top' to mark the `Top' node in the file. *Note `@top':
  179. makeinfo top.
  180.  
  181.    Finally, you must write the name of each node (except for the `Top'
  182. node) in a menu that is one or more hierarchical levels above the
  183. node's hierarchical level.
  184.  
  185.    This node pointer insertion feature in `makeinfo' is an alternative
  186. to the menu and pointer creation and update commands in Texinfo mode.
  187. (*Note Updating Nodes and Menus::.)  It is especially helpful to people
  188. who do not use GNU Emacs for writing Texinfo documents.
  189.  
  190. 
  191. File: texi.info,  Node: Menus,  Next: Cross References,  Prev: Nodes,  Up: Top
  192.  
  193. Menus
  194. *****
  195.  
  196.    "Menus" contain pointers to subordinate nodes.(1) In Info, you use
  197. menus to go to such nodes.  Menus have no effect in printed manuals and
  198. do not appear in them.
  199.  
  200.    By convention, a menu is put at the end of a node since a reader who
  201. uses the menu may not see text that follows it.
  202.  
  203.    A node that has a menu should *not* contain much text.  If you have
  204. a lot of text and a menu, move most of the text into a new subnode--all
  205. but a few lines.
  206.  
  207. * Menu:
  208.  
  209. * Menu Location::               Put a menu in a short node.
  210. * Writing a Menu::              What is a menu?
  211. * Menu Parts::                  A menu entry has three parts.
  212. * Less Cluttered Menu Entry::   Two part menu entry.
  213. * Menu Example::                Two and three part menu entries.
  214. * Other Info Files::            How to refer to a different Info file.
  215.  
  216.    ---------- Footnotes ----------
  217.  
  218.    (1)  Menus can carry you to any node, regardless of the hierarchical
  219. structure; even to nodes in a different Info file.  However, the GNU
  220. Emacs Texinfo mode updating commands work only to create menus of
  221. subordinate nodes.  Conventionally, cross references are used to refer
  222. to other nodes.
  223.  
  224. 
  225. File: texi.info,  Node: Menu Location,  Next: Writing a Menu,  Up: Menus
  226.  
  227. Menus Need Short Nodes
  228. ======================
  229.  
  230.    A reader can easily see a menu that is close to the beginning of the
  231. node.  The node should be short.  As a practical matter, you should
  232. locate a menu within 20 lines of the beginning of the node.  Otherwise,
  233. a reader with a terminal that displays only a few lines may miss the
  234. menu and its associated text.
  235.  
  236.    The short text before a menu may look awkward in a printed manual.
  237. To avoid this, you can write a menu near the beginning of its node and
  238. follow the menu by an `@node' line, and then an `@heading' line located
  239. within `@ifinfo' and `@end ifinfo'.  This way, the menu, `@node' line,
  240. and title appear only in the Info file, not the printed document.
  241.  
  242.    For example, the preceding two paragraphs follow an Info-only menu,
  243. `@node' line, and heading, and look like this:
  244.  
  245.      @menu
  246.      * Menu Location::             Put a menu in a short node.
  247.      * Writing a Menu::            What is a menu?
  248.      * Menu Parts::                A menu entry has three parts.
  249.      * Less Cluttered Menu Entry:: Two part menu entry.
  250.      * Menu Example::              Two and three part entries.
  251.      * Other Info Files::          How to refer to a different
  252.                                      Info file.
  253.      @end menu
  254.      
  255.      @node Menu Location, Writing a Menu,  , Menus
  256.      @ifinfo
  257.      @heading Menus Need Short Nodes
  258.      @end ifinfo
  259.  
  260.    The Texinfo file for this document contains more than a dozen
  261. examples of this procedure.  One is at the beginning of this chapter;
  262. another is at the beginning of the "Cross References" chapter.
  263.  
  264. 
  265. File: texi.info,  Node: Writing a Menu,  Next: Menu Parts,  Prev: Menu Location,  Up: Menus
  266.  
  267. Writing a Menu
  268. ==============
  269.  
  270.    A menu consists of an `@menu' command on a line by itself followed
  271. by menu entry lines or menu comment lines and then by an `@end menu'
  272. command on a line by itself.
  273.  
  274.    A menu looks like this:
  275.  
  276.      @menu
  277.      Larger Units of Text
  278.      
  279.      * Files::                       All about handling files.
  280.      * Multiples: Buffers.           Multiple buffers; editing
  281.                                        several files at once.
  282.      @end menu
  283.  
  284.    In a menu, every line that begins with an `* ' is a "menu entry".
  285. (Note the space after the asterisk.)  A line that does not start with
  286. an `* ' may also appear in a menu.  Such a line is not a menu entry but
  287. is a menu comment line that appears in the Info file.  In the example
  288. above, the line `Larger Units of Text' is a menu comment line; the two
  289. lines starting with `* ' are menu entries.
  290.  
  291. 
  292. File: texi.info,  Node: Menu Parts,  Next: Less Cluttered Menu Entry,  Prev: Writing a Menu,  Up: Menus
  293.  
  294. The Parts of a Menu
  295. ===================
  296.  
  297.    A menu entry has three parts, only the second of which is required:
  298.  
  299.   1. The menu entry name.
  300.  
  301.   2. The name of the node (required).
  302.  
  303.   3. A description of the item.
  304.  
  305.    The template for a menu entry looks like this:
  306.  
  307.      * MENU-ENTRY-NAME: NODE-NAME.   DESCRIPTION
  308.  
  309.    Follow the menu entry name with a single colon and follow the node
  310. name with tab, comma, period, or newline.
  311.  
  312.    In Info, a user selects a node with the `m' (`Info-menu') command.
  313. The menu entry name is what the user types after the `m' command.
  314.  
  315.    The third part of a menu entry is a descriptive phrase or sentence.
  316. Menu entry names and node names are often short; the description
  317. explains to the reader what the node is about.  The description, which
  318. is optional, can spread over two or more lines.  A useful description
  319. complements the node name rather than repeats it.
  320.  
  321. 
  322. File: texi.info,  Node: Less Cluttered Menu Entry,  Next: Menu Example,  Prev: Menu Parts,  Up: Menus
  323.  
  324. Less Cluttered Menu Entry
  325. =========================
  326.  
  327.    When the menu entry name and node name are the same, you can write
  328. the name immediately after the asterisk and space at the beginning of
  329. the line and follow the name with two colons.
  330.  
  331.    For example, write
  332.  
  333.      * Name::                                    DESCRIPTION
  334.  
  335. instead of
  336.  
  337.      * Name: Name.                               DESCRIPTION
  338.  
  339.    You should use the node name for the menu entry name whenever
  340. possible, since it reduces visual clutter in the menu.
  341.  
  342. 
  343. File: texi.info,  Node: Menu Example,  Next: Other Info Files,  Prev: Less Cluttered Menu Entry,  Up: Menus
  344.  
  345. A Menu Example
  346. ==============
  347.  
  348.    A menu looks like this in Texinfo:
  349.  
  350.      @menu
  351.      * menu entry name: Node name.   A short description.
  352.      * Node name::                   This form is preferred.
  353.      @end menu
  354.  
  355. This produces:
  356.  
  357.      * menu:
  358.      
  359.      * menu entry name: Node name.   A short description.
  360.      * Node name::                   This form is preferred.
  361.  
  362.    Here is an example as you might see it in a Texinfo file:
  363.  
  364.      @menu
  365.      Larger Units of Text
  366.      
  367.      * Files::                       All about handling files.
  368.      * Multiples: Buffers.           Multiple buffers; editing
  369.                                        several files at once.
  370.      @end menu
  371.  
  372. This produces:
  373.  
  374.      * menu:
  375.      Larger Units of Text
  376.      
  377.      * Files::                       All about handling files.
  378.      * Multiples: Buffers.           Multiple buffers; editing
  379.                                        several files at once.
  380.  
  381.    In this example, the menu has two entries.  `Files' is both a menu
  382. entry name and the name of the node referred to by that name.
  383. `Multiples' is the menu entry name; it refers to the node named
  384. `Buffers'. The line `Larger Units of Text' is a comment; it appears in
  385. the menu, but is not an entry.
  386.  
  387.    Since no file name is specified with either `Files' or `Buffers',
  388. they must be the names of nodes in the same Info file (*note Referring
  389. to Other Info Files: Other Info Files.).
  390.  
  391. 
  392. File: texi.info,  Node: Other Info Files,  Prev: Menu Example,  Up: Menus
  393.  
  394. Referring to Other Info Files
  395. =============================
  396.  
  397.    You can create a menu entry that enables a reader in Info to go to a
  398. node in another Info file by writing the file name in parentheses just
  399. before the node name.  In this case, you should use the three-part menu
  400. entry format, which saves the reader from having to type the file name.
  401.  
  402.    The format looks like this:
  403.  
  404.      @menu
  405.      * FIRST-ENTRY-NAME:(FILENAME)NODENAME.     DESCRIPTION
  406.      * SECOND-ENTRY-NAME:(FILENAME)SECOND-NODE. DESCRIPTION
  407.      @end menu
  408.  
  409.    For example, to refer directly to the `Outlining' and `Rebinding'
  410. nodes in the `Emacs Manual', you would write a menu like this:
  411.  
  412.      @menu
  413.      * Outlining: (emacs)Outline Mode. The major mode for
  414.                                        editing outlines.
  415.      * Rebinding: (emacs)Rebinding.    How to redefine the
  416.                                        meaning of a key.
  417.      @end menu
  418.  
  419.    If you do not list the node name, but only name the file, then Info
  420. presumes that you are referring to the `Top' node.
  421.  
  422.    The `dir' file that contains the main menu for Info has menu entries
  423. that list only file names.  These take you directly to the `Top' nodes
  424. of each Info document.  (*Note Install an Info File::.)
  425.  
  426.    For example:
  427.  
  428.      * Info: (info).         Documentation browsing system.
  429.      * Emacs: (emacs).       The extensible, self-documenting
  430.                              text editor.
  431.  
  432. (The `dir' top level directory for the Info system is an Info file, not
  433. a Texinfo file, but a menu entry looks the same in both types of file.)
  434.  
  435.    Note that the GNU Emacs Texinfo mode menu updating commands only work
  436. with nodes within the current buffer, so you cannot use them to create
  437. menus that refer to other files.  You must write such menus by hand.
  438.  
  439. 
  440. File: texi.info,  Node: Cross References,  Next: Marking Text,  Prev: Menus,  Up: Top
  441.  
  442. Cross References
  443. ****************
  444.  
  445.    "Cross references" are used to refer the reader to other parts of the
  446. same or different Texinfo files.  In Texinfo, nodes are the places to
  447. which cross references can refer.
  448.  
  449. * Menu:
  450.  
  451. * References::                  What cross references are for.
  452. * Cross Reference Commands::    A summary of the different commands.
  453. * Cross Reference Parts::       A cross reference has several parts.
  454. * xref::                        Begin a reference with `See' ...
  455. * Top Node Naming::             How to refer to the beginning of another file.
  456. * ref::                         A reference for the last part of a sentence.
  457. * pxref::                       How to write a parenthetical cross reference.
  458. * inforef::                     How to refer to an Info-only file.
  459.  
  460. 
  461. File: texi.info,  Node: References,  Next: Cross Reference Commands,  Up: Cross References
  462.  
  463. What References Are For
  464. =======================
  465.  
  466.    Often, but not always, a printed document should be designed so that
  467. it can be read sequentially.  People tire of flipping back and forth to
  468. find information that should be presented to them as they need it.
  469.  
  470.    However, in any document, some information will be too detailed for
  471. the current context, or incidental to it; use cross references to
  472. provide access to such information.  Also, an on-line help system or a
  473. reference manual is not like a novel; few read such documents in
  474. sequence from beginning to end.  Instead, people look up what they
  475. need.  For this reason, such creations should contain many cross
  476. references to help readers find other information that they may not
  477. have read.
  478.  
  479.    In a printed manual, a cross reference results in a page reference,
  480. unless it is to another manual altogether, in which case the cross
  481. reference names that manual.
  482.  
  483.    In Info, a cross reference results in an entry that you can follow
  484. using the Info `f' command.  (*note Some advanced Info commands:
  485. (info)Help-Adv.)
  486.  
  487.    The various cross reference commands use nodes to define cross
  488. reference locations.  This is evident in Info, in which a cross
  489. reference takes you to the specified node.  TeX also uses nodes to
  490. define cross reference locations, but the action is less obvious.  When
  491. TeX generates a DVI file, it records nodes' page numbers and uses the
  492. page numbers in making references.  Thus, if you are writing a manual
  493. that will only be printed, and will not be used on-line, you must
  494. nonetheless write `@node' lines to name the places to which you make
  495. cross references.
  496.  
  497. 
  498. File: texi.info,  Node: Cross Reference Commands,  Next: Cross Reference Parts,  Prev: References,  Up: Cross References
  499.  
  500. Different Cross Reference Commands
  501. ==================================
  502.  
  503.    There are four different cross reference commands:
  504.  
  505. `@xref'
  506.      Used to start a sentence in the printed manual saying `See ...' or
  507.      an entry in the Info file saying `*Note ...'.
  508.  
  509. `@ref'
  510.      Used within or, more often, at the end of a sentence; same as
  511.      `@xref' for Info; produces just the reference in the printed
  512.      manual without a preceding `See'.
  513.  
  514. `@pxref'
  515.      Used within parentheses to make a reference that suits both an Info
  516.      file and a printed book.  Starts with a lower case `see' within the
  517.      printed manual. (`p' is for `parenthesis'.)
  518.  
  519. `@inforef'
  520.      Used to make a reference to an Info file for which there is no
  521.      printed manual.
  522.  
  523. (The `@cite' command is used to make references to books and manuals
  524. for which there is no corresponding Info file and, therefore, no node
  525. to which to point.   *Note `@cite': cite.)
  526.  
  527. 
  528. File: texi.info,  Node: Cross Reference Parts,  Next: xref,  Prev: Cross Reference Commands,  Up: Cross References
  529.  
  530. Parts of a Cross Reference
  531. ==========================
  532.  
  533.    A cross reference command requires only one argument, which is the
  534. name of the node to which it refers.  But a cross reference command may
  535. contain up to four additional arguments.  By using these arguments, you
  536. can provide a cross reference name for Info, a topic description or
  537. section title for the printed output, the name of a different Info
  538. file, and the name of a different printed manual.
  539.  
  540.    Here is a simple cross reference example:
  541.  
  542.      @xref{Node name}.
  543.  
  544. which produces
  545.  
  546.      *Note Node name::.
  547.  
  548. and
  549.  
  550.      See Section NNN [Node name], page PPP.
  551.  
  552.    Here is an example of a full five-part cross reference:
  553.  
  554.      @xref{Node name, Cross Reference Name, Particular Topic,
  555.      info-file-name, A Printed Manual}, for details.
  556.  
  557. which produces
  558.  
  559.      *Note Cross Reference Name: (info-file-name)Node name,
  560.      for details.
  561.  
  562. in Info and
  563.  
  564.      See section "Particular Topic" in A Printed Manual, for details.
  565.  
  566. in a printed book.
  567.  
  568.    The five possible arguments for a cross reference are:
  569.  
  570.   1. The node name (required).  This is the node to which the cross
  571.      reference takes you.  In a printed document, the location of the
  572.      node provides the page reference only for references within the
  573.      same document.
  574.  
  575.   2. The cross reference name for the Info reference, if it is to be
  576.      different from the node name.  If you include this argument, it
  577.      argument becomes the first part of the cross reference. It is
  578.      usually omitted.
  579.  
  580.   3. A topic description or section name.  Often, this is the title of
  581.      the section.  This is used as the name of the reference in the
  582.      printed manual.  If omitted, the node name is used.
  583.  
  584.   4. The name of the Info file in which the reference is located, if it
  585.      is different from the current file.
  586.  
  587.   5. The name of a printed manual from a different Texinfo file.
  588.  
  589.    The template for a full five argument cross reference looks like
  590. this:
  591.  
  592.      @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC,
  593.      INFO-FILE-NAME, PRINTED-MANUAL-TITLE}.
  594.  
  595.    Cross references with one, two, three, four, and five arguments are
  596. described separately following the description of `@xref'.
  597.  
  598.    Write a node name in a cross reference in exactly the same way as in
  599. the `@node' line, including the same capitalization; otherwise, the
  600. formatters may not find the reference.
  601.  
  602.    You can write cross reference commands within a paragraph, but note
  603. how Info and TeX format the output of each of the various commands:
  604. write `@xref' at the beginning of a sentence; write `@pxref' only
  605. within parentheses, and so on.
  606.  
  607. 
  608. File: texi.info,  Node: xref,  Next: Top Node Naming,  Prev: Cross Reference Parts,  Up: Cross References
  609.  
  610. `@xref'
  611. =======
  612.  
  613.    The `@xref' command generates a cross reference for the beginning of
  614. a sentence.  The Info formatting commands convert it into an Info cross
  615. reference, which the Info `f' command can use to bring you directly to
  616. another node.  The TeX typesetting commands convert it into a page
  617. reference, or a reference to another book or manual.
  618.  
  619. * Menu:
  620.  
  621. * Reference Syntax::            What a reference looks like and requires.
  622. * One Argument::                `@xref' with one argument.
  623. * Two Arguments::               `@xref' with two arguments.
  624. * Three Arguments::             `@xref' with three arguments.
  625. * Four and Five Arguments::     `@xref' with four and five arguments.
  626.  
  627. 
  628. File: texi.info,  Node: Reference Syntax,  Next: One Argument,  Up: xref
  629.  
  630. What a Reference Looks Like and Requires
  631. ----------------------------------------
  632.  
  633.    Most often, an Info cross reference looks like this:
  634.  
  635.      *Note NODE-NAME::.
  636.  
  637. or like this
  638.  
  639.      *Note CROSS-REFERENCE-NAME: NODE-NAME.
  640.  
  641. In TeX, a cross reference looks like this:
  642.  
  643.      See Section SECTION-NUMBER [NODE-NAME], page PAGE.
  644.  
  645. or like this
  646.  
  647.      See Section SECTION-NUMBER [TITLE-OR-TOPIC], page PAGE.
  648.  
  649.    The `@xref' command does not generate a period or comma to end the
  650. cross reference in either the Info file or the printed output.  You
  651. must write that period or comma yourself; otherwise, Info will not
  652. recognize the end of the reference.  (The `@pxref' command works
  653. differently.  *Note `@pxref': pxref.)
  654.  
  655.      *Please note:* A period or comma *must* follow the closing brace
  656.      of an `@xref'.  It is required to terminate the cross reference.
  657.      This period or comma will appear in the output, both in the Info
  658.      file and in the printed manual.
  659.  
  660.    `@xref' must refer to an Info node by name.  Use `@node' to define
  661. the node (*note Writing a Node::.).
  662.  
  663.    `@xref' is followed by several arguments inside braces, separated by
  664. commas.  Whitespace before and after these commas is ignored.
  665.  
  666.    A cross reference requires only the name of a node; but it may
  667. contain up to four additional arguments.  Each of these variations
  668. produces a cross reference that looks somewhat different.
  669.  
  670.      *Please note:* Commas separate arguments in a cross reference;
  671.      avoid including them in the title or other part lest the formatters
  672.      mistake them for separators.
  673.  
  674. 
  675. File: texi.info,  Node: One Argument,  Next: Two Arguments,  Prev: Reference Syntax,  Up: xref
  676.  
  677. `@xref' with One Argument
  678. -------------------------
  679.  
  680.    The simplest form of `@xref' takes one argument, the name of another
  681. node in the same Info file.    The Info formatters produce output that
  682. the Info readers can use to jump to the reference; TeX produces output
  683. that specifies the page and section number for you.
  684.  
  685. For example,
  686.  
  687.      @xref{Tropical Storms}.
  688.  
  689. produces
  690.  
  691.      *Note Tropical Storms::.
  692.  
  693. and
  694.  
  695.      See Section 3.1 [Tropical Storms], page 24.
  696.  
  697. (Note that in the preceding example the closing brace is followed by a
  698. period.)
  699.  
  700.    You can write a clause after the cross reference, like this:
  701.  
  702.      @xref{Tropical Storms}, for more info.
  703.  
  704. which produces
  705.  
  706.      *Note Tropical Storms::, for more info.
  707.  
  708.      See Section 3.1 [Tropical Storms], page 24, for more info.
  709.  
  710. (Note that in the preceding example the closing brace is followed by a
  711. comma, and then by the clause, which is followed by a period.)
  712.  
  713. 
  714. File: texi.info,  Node: Two Arguments,  Next: Three Arguments,  Prev: One Argument,  Up: xref
  715.  
  716. `@xref' with Two Arguments
  717. --------------------------
  718.  
  719.    With two arguments, the second is used as the name of the Info cross
  720. reference, while the first is still the name of the node to which the
  721. cross reference points.
  722.  
  723. The template is like this:
  724.  
  725.      @xref{NODE-NAME, CROSS-REFERENCE-NAME}.
  726.  
  727. For example,
  728.  
  729.      @xref{Electrical Effects, Lightning}.
  730.  
  731. produces:
  732.  
  733.      *Note Lightning: Electrical Effects.
  734.  
  735. and
  736.  
  737.      See Section 5.2 [Electrical Effects], page 57.
  738.  
  739. (Note that in the preceding example the closing brace is followed by a
  740. period; and that the node name is printed, not the cross reference
  741. name.)
  742.  
  743.    You can write a clause after the cross reference, like this:
  744.  
  745.      @xref{Electrical Effects, Lightning}, for more info.
  746.  
  747. which produces
  748.      *Note Lightning: Electrical Effects, for more info.
  749.  
  750. and
  751.  
  752.      See Section 5.2 [Electrical Effects], page 57, for more info.
  753.  
  754. (Note that in the preceding example the closing brace is followed by a
  755. comma, and then by the clause, which is followed by a period.)
  756.  
  757. 
  758. File: texi.info,  Node: Three Arguments,  Next: Four and Five Arguments,  Prev: Two Arguments,  Up: xref
  759.  
  760. `@xref' with Three Arguments
  761. ----------------------------
  762.  
  763.    A third argument replaces the node name in the TeX output.  The third
  764. argument should be the name of the section in the printed output, or
  765. else state the topic discussed by that section.  Often, you will want to
  766. use initial upper case letters so it will be easier to read when the
  767. reference is printed.  Use a third argument when the node name is
  768. unsuitable because of syntax or meaning.
  769.  
  770.    Remember to avoid placing a comma within the title or topic section
  771. of a cross reference, or within any other section.  The formatters
  772. divide cross references into arguments according to the commas; a comma
  773. within a title or other section will divide it into two arguments.  In
  774. a reference, you need to write a title such as "Clouds, Mist, and Fog"
  775. without the commas.
  776.  
  777.    Also, remember to write a comma or period after the closing brace of
  778. a `@xref' to terminate the cross reference.  In the following examples,
  779. a clause follows a terminating comma.
  780.  
  781. The template is like this:
  782.  
  783.      @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC}.
  784.  
  785. For example,
  786.  
  787.      @xref{Electrical Effects, Lightning, Thunder and Lightning},
  788.      for details.
  789.  
  790. produces
  791.  
  792.      *Note Lightning: Electrical Effects, for details.
  793.  
  794. and
  795.  
  796.      See Section 5.2 [Thunder and Lightning], page 57, for details.
  797.  
  798.    If a third argument is given and the second one is empty, then the
  799. third argument serves both.  (Note how two commas, side by side, mark
  800. the empty second argument.)
  801.  
  802.      @xref{Electrical Effects, , Thunder and Lightning},
  803.      for details.
  804.  
  805. produces
  806.  
  807.      *Note Thunder and Lightning: Electrical Effects, for details.
  808.  
  809. and
  810.  
  811.      See Section 5.2 [Thunder and Lightning], page 57, for details.
  812.  
  813.    As a practical matter, it is often best to write cross references
  814. with just the first argument if the node name and the section title are
  815. the same, and with the first and third arguments if the node name and
  816. title are different.
  817.  
  818.    Here are several examples from `The GAWK Manual':
  819.  
  820.      @xref{Sample Program}.
  821.      @xref{Glossary}.
  822.      @xref{Case-sensitivity, ,Case-sensitivity in Matching}.
  823.      @xref{Close Output, , Closing Output Files and Pipes},
  824.         for more information.
  825.      @xref{Regexp, , Regular Expressions as Patterns}.
  826.  
  827. 
  828. File: texi.info,  Node: Four and Five Arguments,  Prev: Three Arguments,  Up: xref
  829.  
  830. `@xref' with Four and Five Arguments
  831. ------------------------------------
  832.  
  833.    In a cross reference, a fourth argument specifies the name of another
  834. Info file, different from the file in which the reference appears, and
  835. a fifth argument specifies its title as a printed manual.
  836.  
  837.    Remember that a comma or period must follow the closing brace of an
  838. `@xref' command to terminate the cross reference.  In the following
  839. examples, a clause follows a terminating comma.
  840.  
  841. The template is:
  842.  
  843.      @xref{NODE-NAME, CROSS-REFERENCE-NAME, TITLE-OR-TOPIC,
  844.      INFO-FILE-NAME, PRINTED-MANUAL-TITLE}.
  845.  
  846. For example,
  847.  
  848.      @xref{Electrical Effects, Lightning, Thunder and Lightning,
  849.      weather, An Introduction to Meteorology}, for details.
  850.  
  851. produces
  852.  
  853.      *Note Lightning: (weather)Electrical Effects, for details.
  854.  
  855. The name of the Info file is enclosed in parentheses and precedes the
  856. name of the node.
  857.  
  858. In a printed manual, the reference looks like this:
  859.  
  860.      See section "Thunder and Lightning" in An Introduction to
  861.      Meteorology, for details.
  862.  
  863. The title of the printed manual is typeset in italics; and the
  864. reference lacks a page number since TeX cannot know to which page a
  865. reference refers when that reference is to another manual.
  866.  
  867.    Often, you will leave out the second argument when you use the long
  868. version of `@xref'.  In this case, the third argument, the topic
  869. description, will be used as the cross reference name in Info.
  870.  
  871. The template looks like this:
  872.  
  873.      @xref{NODE-NAME, , TITLE-OR-TOPIC, INFO-FILE-NAME,
  874.      PRINTED-MANUAL-TITLE}, for details.
  875.  
  876. which produces
  877.  
  878.      *Note TITLE-OR-TOPIC: (INFO-FILE-NAME)NODE-NAME, for details.
  879.  
  880. and
  881.  
  882.      See section TITLE-OR-TOPIC in PRINTED-MANUAL-TITLE, for details.
  883.  
  884. For example,
  885.  
  886.      @xref{Electrical Effects, , Thunder and Lightning,
  887.      weather, An Introduction to Meteorology}, for details.
  888.  
  889. produces
  890.  
  891.      *Note Thunder and Lightning: (weather)Electrical Effects,
  892.      for details.
  893.  
  894. and
  895.  
  896.      See section "Thunder and Lightning" in An Introduction to
  897.      Meteorology, for details.
  898.  
  899.    On rare occasions, you may want to refer to another Info file that
  900. is within a single printed manual--when multiple Texinfo files are
  901. incorporated into the same TeX run but make separate Info files.  In
  902. this case, you need to specify only the fourth argument, and not the
  903. fifth.
  904.  
  905. 
  906. File: texi.info,  Node: Top Node Naming,  Next: ref,  Prev: xref,  Up: Cross References
  907.  
  908. Naming a `Top' Node
  909. ===================
  910.  
  911.    In a cross reference, you must always name a node.  This means that
  912. in order to refer to a whole manual, you must identify the `Top' node by
  913. writing it as the first argument to the `@xref' command.  (This is
  914. different from the way you write a menu entry; see *Note Referring to
  915. Other Info Files: Other Info Files.)  At the same time, to provide a
  916. meaningful section topic or title in the printed cross reference
  917. (instead of the word `Top'), you must write an appropriate entry for
  918. the third argument to the `@xref' command.
  919.  
  920. Thus, to make a cross reference to `The GNU Make Manual', write:
  921.  
  922.      @xref{Top, , Overview, make, The GNU Make Manual}.
  923.  
  924. which produces
  925.  
  926.      *Note Overview: (make)Top.
  927.  
  928. and
  929.  
  930.      See section "Overview" in The GNU Make Manual.
  931.  
  932. In this example, `Top' is the name of the first node, and `Overview' is
  933. the name of the first section of the manual.
  934.  
  935. 
  936. File: texi.info,  Node: ref,  Next: pxref,  Prev: Top Node Naming,  Up: Cross References
  937.  
  938. `@ref'
  939. ======
  940.  
  941.    `@ref' is nearly the same as `@xref' except that it does not
  942. generate a `See' in the printed output, just the reference itself.
  943. This makes it useful as the last part of a sentence.
  944.  
  945. For example,
  946.  
  947.      For more information, see @ref{Hurricanes}.
  948.  
  949. produces
  950.  
  951.      For more information, see *Note Hurricanes.
  952.  
  953. and
  954.  
  955.      For more information, see Section 8.2 [Hurricanes], page 123.
  956.  
  957.    The `@ref' command sometimes leads writers to express themselves in
  958. a manner that is suitable for a printed manual but looks awkward in the
  959. Info format.  Bear in mind that your audience will be using both the
  960. printed and the Info format.
  961.  
  962. For example,
  963.  
  964.      Sea surges are described in @ref{Hurricanes}.
  965.  
  966. produces
  967.  
  968.      Sea surges are described in Section 6.7 [Hurricanes], page 72.
  969.  
  970. in a printed document, and the following in Info:
  971.  
  972.      Sea surges are described in *Note Hurricanes::.
  973.  
  974.      *Caution:* You *must* write a period or comma immediately after an
  975.      `@ref' command with two or more arguments.  Otherwise, Info will
  976.      not find the end of the cross reference entry and its attempt to
  977.      follow the cross reference will fail.  As a general rule, you
  978.      should write a period or comma after every `@ref' command.  This
  979.      looks best in both the printed and the Info output.
  980.  
  981. 
  982. File: texi.info,  Node: pxref,  Next: inforef,  Prev: ref,  Up: Cross References
  983.  
  984. `@pxref'
  985. ========
  986.  
  987.    The parenthetical reference command, `@pxref', is nearly the same as
  988. `@xref', but you use it *only* inside parentheses and you do *not* type
  989. a comma or period after the command's closing brace.  The command
  990. differs from `@xref' in two ways:
  991.  
  992.   1. TeX typesets the reference for the printed manual with a lower case
  993.      `see' rather than an upper case `See'.
  994.  
  995.   2. The Info formatting commands automatically end the reference with a
  996.      closing colon or period.
  997.  
  998.    Because one type of formatting automatically inserts closing
  999. punctuation and the other does not, you should use `@pxref' *only*
  1000. inside parentheses as part of another sentence.  Also, you yourself
  1001. should not insert punctuation after the reference, as you do with
  1002. `@xref'.
  1003.  
  1004.    `@pxref' is designed so that the output looks right and works right
  1005. between parentheses both in printed output and in an Info file.  In a
  1006. printed manual, a closing comma or period should not follow a cross
  1007. reference within parentheses; such punctuation is wrong.  But in an
  1008. Info file, suitable closing punctuation must follow the cross reference
  1009. so Info can recognize its end.  `@pxref' spares you the need to use
  1010. complicated methods to put a terminator into one form of the output and
  1011. not the other.
  1012.  
  1013. With one argument, a parenthetical cross reference looks like this:
  1014.  
  1015.      ... storms cause flooding (@pxref{Hurricanes}) ...
  1016.  
  1017. which produces
  1018.  
  1019.      ... storms cause flooding (*Note Hurricanes::) ...
  1020.  
  1021. and
  1022.  
  1023.      ... storms cause flooding (see Section 6.7 [Hurricanes], page 72)
  1024.      ...
  1025.  
  1026.    With two arguments, a parenthetical cross reference has this
  1027. template:
  1028.  
  1029.      ... (@pxref{NODE-NAME, CROSS-REFERENCE-NAME}) ...
  1030.  
  1031. which produces
  1032.  
  1033.      ... (*Note CROSS-REFERENCE-NAME: NODE-NAME.) ...
  1034.  
  1035. and
  1036.  
  1037.      ... (see Section NNN [NODE-NAME], page PPP) ...
  1038.  
  1039.    `@pxref' can be used with up to five arguments just like `@xref'
  1040. (*note `@xref': xref.).
  1041.  
  1042.      *Please note:* Use `@pxref' only as a parenthetical reference.  Do
  1043.      not try to use `@pxref' as a clause in a sentence.  It will look
  1044.      bad in either the Info file, the printed output, or both.
  1045.  
  1046.      Also, parenthetical cross references look best at the ends of
  1047.      sentences.  Although you may write them in the middle of a
  1048.      sentence, that location breaks up the flow of text.
  1049.  
  1050. 
  1051. File: texi.info,  Node: inforef,  Prev: pxref,  Up: Cross References
  1052.  
  1053. `@inforef'
  1054. ==========
  1055.  
  1056.    `@inforef' is used for cross references to Info files for which
  1057. there are no printed manuals.  Even in a printed manual, `@inforef'
  1058. generates a reference directing the user to look in an Info file.
  1059.  
  1060.    The command takes either two or three arguments, in the following
  1061. order:
  1062.  
  1063.   1. The node name.
  1064.  
  1065.   2. The cross reference name (optional).
  1066.  
  1067.   3. The Info file name.
  1068.  
  1069. Separate the arguments with commas, as with `@xref'.  Also, you must
  1070. terminate the reference with a comma or period after the `}', as you do
  1071. with `@xref'.
  1072.  
  1073. The template is:
  1074.  
  1075.      @inforef{NODE-NAME, CROSS-REFERENCE-NAME, INFO-FILE-NAME},
  1076.  
  1077. Thus,
  1078.  
  1079.      @inforef{Expert, Advanced Info commands, info},
  1080.      for more information.
  1081.  
  1082. produces
  1083.  
  1084.      *Note Advanced Info commands: (info)Expert,
  1085.      for more information.
  1086.  
  1087. and
  1088.  
  1089.      See Info file `info', node `Expert', for more information.
  1090.  
  1091. Similarly,
  1092.  
  1093.      @inforef{Expert, , info}, for more information.
  1094.  
  1095. produces
  1096.  
  1097.      *Note (info)Expert::, for more information.
  1098.  
  1099. and
  1100.  
  1101.      See Info file `info', node `Expert', for more information.
  1102.  
  1103.    The converse of `@inforef' is `@cite', which is used to refer to
  1104. printed works for which no Info form exists.  *Note `@cite': cite.
  1105.  
  1106. 
  1107. File: texi.info,  Node: Marking Text,  Next: Quotations and Examples,  Prev: Cross References,  Up: Top
  1108.  
  1109. Marking Words and Phrases
  1110. *************************
  1111.  
  1112.    In Texinfo, you can mark words and phrases in a variety of ways.
  1113. The Texinfo formatters use this information to determine how to
  1114. highlight the text.  You can specify, for example, whether a word or
  1115. phrase is a defining occurrence, a metasyntactic variable, or a symbol
  1116. used in a program.  Also, you can emphasize text.
  1117.  
  1118. * Menu:
  1119.  
  1120. * Indicating::                  How to indicate definitions, files, etc.
  1121. * Emphasis::                    How to emphasize text.
  1122.  
  1123. 
  1124. File: texi.info,  Node: Indicating,  Next: Emphasis,  Up: Marking Text
  1125.  
  1126. Indicating Definitions, Commands, etc.
  1127. ======================================
  1128.  
  1129.    Texinfo has commands for indicating just what kind of object a piece
  1130. of text refers to.  For example, metasyntactic variables are marked by
  1131. `@var', and code by `@code'.  Since the pieces of text are labelled by
  1132. commands that tell what kind of object they are, it is easy to change
  1133. the way the Texinfo formatters prepare such text.  (Texinfo is an
  1134. *intentional* formatting language rather than a *typesetting*
  1135. formatting language.)
  1136.  
  1137.    For example, in a printed manual, code is usually illustrated in a
  1138. typewriter font; `@code' tells TeX to typeset this text in this font.
  1139. But it would be easy to change the way TeX highlights code to use
  1140. another font, and this change would not effect how keystroke examples
  1141. are highlighted.  If straight typesetting commands were used in the body
  1142. of the file and you wanted to make a change, you would need to check
  1143. every single occurrence to make sure that you were changing code and
  1144. not something else that should not be changed.
  1145.  
  1146. * Menu:
  1147.  
  1148. * Useful Highlighting::         Highlighting provides useful information.
  1149. * code::                        How to indicate code.
  1150. * kbd::                         How to show keyboard input.
  1151. * key::                         How to specify keys.
  1152. * samp::                        How to show a literal sequence of characters.
  1153. * var::                         How to indicate a metasyntactic variable.
  1154. * file::                        How to indicate the name of a file.
  1155. * dfn::                         How to specify a definition.
  1156. * cite::                        How to refer to a book that is not in Info.
  1157.  
  1158. 
  1159. File: texi.info,  Node: Useful Highlighting,  Next: code,  Up: Indicating
  1160.  
  1161. Highlighting Commands are Useful
  1162. --------------------------------
  1163.  
  1164.    The highlighting commands can be used to generate useful information
  1165. from the file, such as lists of functions or file names.  It is
  1166. possible, for example, to write a program in Emacs Lisp (or a keyboard
  1167. macro) to insert an index entry after every paragraph that contains
  1168. words or phrases marked by a specified command.  You could do this to
  1169. construct an index of functions if you had not already made the entries.
  1170.  
  1171.    The commands serve a variety of purposes:
  1172.  
  1173. `@code{SAMPLE-CODE}'
  1174.      Indicate text that is a literal example of a piece of a program.
  1175.  
  1176. `@kbd{KEYBOARD-CHARACTERS}'
  1177.      Indicate keyboard input.
  1178.  
  1179. `@key{KEY-NAME}'
  1180.      Indicate the conventional name for a key on a keyboard.
  1181.  
  1182. `@samp{TEXT}'
  1183.      Indicate text that is a literal example of a sequence of
  1184.      characters.
  1185.  
  1186. `@var{METASYNTACTIC-VARIABLE}'
  1187.      Indicate a metasyntactic variable.
  1188.  
  1189. `@file{FILE-NAME}'
  1190.      Indicate the name of a file.
  1191.  
  1192. `@dfn{TERM}'
  1193.      Indicate the introductory or defining use of a term.
  1194.  
  1195. `@cite{REFERENCE}'
  1196.      Indicate the name of a book.
  1197.  
  1198. 
  1199. File: texi.info,  Node: code,  Next: kbd,  Prev: Useful Highlighting,  Up: Indicating
  1200.  
  1201. `@code'{SAMPLE-CODE}
  1202. --------------------
  1203.  
  1204.    Use the `@code' command to indicate text that is a piece of a
  1205. program and which consists of entire syntactic tokens.  Enclose the
  1206. text in braces.
  1207.  
  1208.    Thus, you should use `@code' for an expression in a program, for the
  1209. name of a variable or function used in a program, or for a keyword.
  1210. Also, you should use `@code' for the name of a program, such as `diff',
  1211. that is a name used in the machine. (You should write the name of a
  1212. program in the ordinary text font if you regard it as a new English
  1213. word, such as `Emacs' or `Bison'.)
  1214.  
  1215.    Use `@code' for environment variables such as `TEXINPUTS', and other
  1216. variables.
  1217.  
  1218.    Use `@code' for command names in command languages that resemble
  1219. programming languages, such as Texinfo or the shell.  For example,
  1220. `@code' and `@samp' are produced by writing `@code{@@code}' and
  1221. `@code{@@samp}' in the Texinfo source, respectively.
  1222.  
  1223.    Note, however, that you should not use `@code' for shell options
  1224. such as `-c' when such options stand alone. (Use `@samp'.) Also, an
  1225. entire shell command often looks better if written using `@samp' rather
  1226. than `@code'.  In this case, the rule is to choose the more pleasing
  1227. format.
  1228.  
  1229.    It is incorrect to alter the case of a word inside an `@code'
  1230. command when it appears at the beginning of a sentence.  Most computer
  1231. languages are case sensitive.  In C, for example, `Printf' is different
  1232. from the identifier `printf', and most likely is a misspelling of it.
  1233. Even in languages which are not case sensitive, it is confusing to a
  1234. human reader to see identifiers spelled in different ways.  Pick one
  1235. spelling and always use that.  If you do not want to start a sentence
  1236. with a command written all in lower case, you should rearrange the
  1237. sentence.
  1238.  
  1239.    Do not use the `@code' command for a string of characters shorter
  1240. than a syntactic token.  If you are writing about `TEXINPU', which is
  1241. just a part of the name for the `TEXINPUTS' environment variable, you
  1242. should use `@samp'.
  1243.  
  1244.    In particular, you should not use the `@code' command when writing
  1245. about the characters used in a token; do not, for example, use `@code'
  1246. when you are explaining what letters or printable symbols can be used
  1247. in the names of functions.  (Use `@samp'.)  Also, you should not use
  1248. `@code' to mark text that is considered input to programs unless the
  1249. input is written in a language that is like a programming language.
  1250. For example, you should not use `@code' for the keystroke commands of
  1251. GNU Emacs (use `@kbd' instead) although you may use `@code' for the
  1252. names of the Emacs Lisp functions that the keystroke commands invoke.
  1253.  
  1254.    In the printed manual, `@code' causes TeX to typeset the argument in
  1255. a typewriter face.  In the Info file, it causes the Info formatting
  1256. commands to use single quotation marks around the text.
  1257.  
  1258.    For example,
  1259.  
  1260.      Use @code{diff} to compare two files.
  1261.  
  1262. produces this in the printed manual:
  1263.  
  1264.      Use `diff' to compare two files.
  1265.  
  1266. 
  1267. File: texi.info,  Node: kbd,  Next: key,  Prev: code,  Up: Indicating
  1268.  
  1269. `@kbd'{KEYBOARD-CHARACTERS}
  1270. ---------------------------
  1271.  
  1272.    Use the `@kbd' command for characters of input to be typed by users.
  1273. For example, to refer to the characters `M-a', write
  1274.  
  1275.      @kbd{M-a}
  1276.  
  1277. and to refer to the characters `M-x shell', write
  1278.  
  1279.      @kbd{M-x shell}
  1280.  
  1281.    The `@kbd' command has the same effect as `@code' in Info, but may
  1282. produce a different font in a printed manual.
  1283.  
  1284.    You can embed another @-command inside the braces of an `@kbd'
  1285. command.  Here, for example, is the way to describe a command that
  1286. would be described more verbosely as "press an `r' and then press the
  1287. RET key":
  1288.  
  1289.      @kbd{r @key{RET}}
  1290.  
  1291. This produces: `r RET'
  1292.  
  1293.    You also use the `@kbd' command if you are spelling out the letters
  1294. you type; for example:
  1295.  
  1296.      To give the @code{logout} command,
  1297.      type the characters @kbd{l o g o u t @key{RET}}.
  1298.  
  1299. This produces:
  1300.  
  1301.      To give the `logout' command, type the characters `l o g o u t
  1302.      RET'.
  1303.  
  1304.    (Also, this example shows that you can add spaces for clarity.  If
  1305. you really want to mention a space character as one of the characters of
  1306. input, write `@key{SPC}' for it.)
  1307.  
  1308. 
  1309. File: texi.info,  Node: key,  Next: samp,  Prev: kbd,  Up: Indicating
  1310.  
  1311. `@key'{KEY-NAME}
  1312. ----------------
  1313.  
  1314.    Use the `@key' command for the conventional name for a key on a
  1315. keyboard, as in:
  1316.  
  1317.      @key{RET}
  1318.  
  1319.    You can use the `@key' command within the argument of an `@kbd'
  1320. command when the sequence of characters to be typed includes one or
  1321. more keys that are described by name.
  1322.  
  1323.    For example, to produce `C-x ESC' you would type:
  1324.  
  1325.      @kbd{C-x @key{ESC}}
  1326.  
  1327.    Here is a list of the recommended names for keys; they are all in
  1328. upper case:
  1329.  
  1330.     SPC
  1331.           Space
  1332.  
  1333.     RET
  1334.           Return
  1335.  
  1336.     LFD
  1337.           Linefeed
  1338.  
  1339.     TAB
  1340.           Tab
  1341.  
  1342.     BS
  1343.           Backspace
  1344.  
  1345.     ESC
  1346.           Escape
  1347.  
  1348.     DEL
  1349.           Delete
  1350.  
  1351.     SFT
  1352.           Shift
  1353.  
  1354.     CTL
  1355.           Control
  1356.  
  1357.     META
  1358.           Meta
  1359.  
  1360.    There are subtleties to handling words like `meta' or `ctl' that are
  1361. names of shift keys.  When mentioning a character in which the shift
  1362. key is used, such as `Meta-a', use the `@kbd' command alone; do not use
  1363. the `@key' command; but when you are referring to the shift key in
  1364. isolation, use the `@key' command.  For example, write `@kbd{Meta-a}'
  1365. to produce `Meta-a' and `@key{META}' to produce META.  This is because
  1366. `Meta-a' refers to keys that you press on a keyboard, but META refers
  1367. to a key without implying that you press it.  In short, use `@kbd' for
  1368. what you do, and use `@key' for what you talk about: "Press `@kbd{M-a}'
  1369. to move point to the beginning of the sentence.  The `@key{META}' key
  1370. is often in the lower left of the keyboard."
  1371.  
  1372. 
  1373. File: texi.info,  Node: samp,  Next: var,  Prev: key,  Up: Indicating
  1374.  
  1375. `@samp'{TEXT}
  1376. -------------
  1377.  
  1378.    Use the `@samp' command to indicate text that is a literal example
  1379. or `sample' of a sequence of characters in a file, string, pattern, etc.
  1380. Enclose the text in braces.  The argument appears within single
  1381. quotation marks in both the Info file and the printed manual; in
  1382. addition, it is printed in a fixed-width font.
  1383.  
  1384.      To match @samp{foo} at the end of the line,
  1385.      use the regexp @samp{foo$}.
  1386.  
  1387. produces
  1388.  
  1389.      To match `foo' at the end of the line, use the regexp `foo$'.
  1390.  
  1391.    Any time you are referring to single characters, you should use
  1392. `@samp' unless `@kbd' is more appropriate.  Use `@samp' for the names
  1393. of command-line options.  Also, you may use `@samp' for entire
  1394. statements in C and for entire shell commands--in this case, `@samp'
  1395. often looks better than `@code'.  Basically, `@samp' is a catchall for
  1396. whatever is not covered by `@code', `@kbd', or `@key'.
  1397.  
  1398.    Only include punctuation marks within braces if they are part of the
  1399. string you are specifying.  Write punctuation marks outside the braces
  1400. if those punctuation marks are part of the English text that surrounds
  1401. the string.  In the following sentence, for example, the commas and
  1402. period are outside of the braces:
  1403.  
  1404.      In English, the vowels are @samp{a}, @samp{e},
  1405.      @samp{i}, @samp{o}, @samp{u}, and sometimes
  1406.      @samp{y}.
  1407.  
  1408. This produces:
  1409.  
  1410.      In English, the vowels are `a', `e', `i', `o', `u',  and sometimes
  1411.      `y'.
  1412.  
  1413.