home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / gnu / info / info-stnd.info (.txt) < prev    next >
GNU Info File  |  1994-02-24  |  54KB  |  1,016 lines
  1. This is Info file info-stnd.info, produced by Makeinfo-1.55 from the
  2. input file info-stnd.texi.
  3. This file documents GNU Info, a program for viewing the on-line
  4. formatted versions of Texinfo files.  This documentation is different
  5. from the documentation for the Info reader that is part of GNU Emacs.
  6. If you do not know how to use Info, but have a working Info reader, you
  7. should read that documentation first.
  8. Copyright (C) 1992, 1993 Free Software Foundation, Inc.
  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 this
  13. manual under the conditions for verbatim copying, provided also that the
  14. sections entitled "Copying" and "GNU General Public License" are
  15. included exactly as in the original, and provided that the entire
  16. resulting derived work is distributed under the terms of a permission
  17. notice identical to this one.
  18. Permission is granted to copy and distribute translations of this manual
  19. into another language, under the above conditions for modified versions,
  20. except that this permission notice may be stated in a translation
  21. approved by the Free Software Foundation.
  22. File: info-stnd.info,  Node: Top,  Next: What is Info,  Prev: (dir),  Up: (dir)
  23. The GNU Info Program
  24. ********************
  25. This file documents GNU Info, a program for viewing the on-line
  26. formatted versions of Texinfo files, version 2.9.  This documentation
  27. is different from the documentation for the Info reader that is part of
  28. GNU Emacs.
  29. * Menu:
  30. * What is Info::
  31. * Options::                     Options you can pass on the command line.
  32. * Cursor Commands::             Commands which move the cursor within a node.
  33. * Scrolling Commands::          Commands for moving the node around
  34.                                   in a window.
  35. * Node Commands::               Commands for selecting a new node.
  36. * Searching Commands::          Commands for searching an Info file.
  37. * Xref Commands::               Commands for selecting cross references.
  38. * Window Commands::             Commands which manipulate multiple windows.
  39. * Printing Nodes::              How to print out the contents of a node.
  40. * Miscellaneous Commands::      A few commands that defy categories.
  41. * Variables::                   How to change the default behavior of Info.
  42. * GNU Info Global Index::       Global index containing keystrokes,
  43.                                   command names, variable names,
  44.                                   and general concepts.
  45. File: info-stnd.info,  Node: What is Info,  Next: Options,  Prev: Top,  Up: Top
  46. What is Info?
  47. *************
  48. "Info" is a program which is used to view Info files on an ASCII
  49. terminal.  "Info files" are the result of processing Texinfo files with
  50. the program `makeinfo' or with one of the Emacs commands, such as `M-x
  51. texinfo-format-buffer'.  Texinfo itself is a documentation system that
  52. uses a single source file to produce both on-line information and
  53. printed output.  You can typeset and print the files that you read in
  54. Info.
  55. File: info-stnd.info,  Node: Options,  Next: Cursor Commands,  Prev: What is Info,  Up: Top
  56. Command Line Options
  57. ********************
  58. GNU Info accepts several options to control the initial node being
  59. viewed, and to specify which directories to search for Info files.  Here
  60. is a template showing an invocation of GNU Info from the shell:
  61.      info [--OPTION-NAME OPTION-VALUE] MENU-ITEM...
  62. The following OPTION-NAMES are available when invoking Info from the
  63. shell:
  64. `--directory DIRECTORY-PATH'
  65. `-d DIRECTORY-PATH'
  66.      Add DIRECTORY-PATH to the list of directory paths searched when
  67.      Info needs to find a file.  You may issue `--directory' multiple
  68.      times; once for each directory which contains Info files.
  69.      Alternatively, you may specify a value for the environment variable
  70.      `INFOPATH'; if `--directory' is not given, the value of `INFOPATH'
  71.      is used.  The value of `INFOPATH' is a colon separated list of
  72.      directory names.  If you do not supply `INFOPATH' or
  73.      `--directory-path', Info uses a default path.
  74. `--file FILENAME'
  75. `-f FILENAME'
  76.      Specify a particular Info file to visit.  By default, Info visits
  77.      the file `dir'; if you use this option, Info will start with
  78.      `(FILENAME)Top' as the first file and node.
  79. `--node NODENAME'
  80. `-n NODENAME'
  81.      Specify a particular node to visit in the initial file that Info
  82.      loads.  This is especially useful in conjunction with `--file'(1)
  83.      (*note Options-Footnotes::).  You may specify `--node' multiple
  84.      times; for an interactive Info, each NODENAME is visited in its
  85.      own window, for a non-interactive Info (such as when `--output' is
  86.      given) each NODENAME is processed sequentially.
  87. `--output FILENAME'
  88. `-o FILENAME'
  89.      Specify FILENAME as the name of a file to which to direct output.
  90.      Each node that Info visits will be output to FILENAME instead of
  91.      interactively viewed.  A value of `-' for FILENAME specifies the
  92.      standard output.
  93. `--subnodes'
  94.      This option only has meaning when given in conjunction with
  95.      `--output'.  It means to recursively output the nodes appearing in
  96.      the menus of each node being output.  Menu items which resolve to
  97.      external Info files are not output, and neither are menu items
  98.      which are members of an index.  Each node is only output once.
  99. `--help'
  100.      Produces a relatively brief description of the available Info
  101.      options.
  102. `--version'
  103.      Prints the version information of Info and exits.
  104. `MENU-ITEM'
  105.      Info treats its remaining arguments as the names of menu items.
  106.      The first argument is a menu item in the initial node visited,
  107.      while the second argument is a menu item in the first argument's
  108.      node.  You can easily move to the node of your choice by
  109.      specifying the menu names which describe the path to that node.
  110.      For example,
  111.           info emacs buffers
  112.      first selects the menu item `Emacs' in the node `(dir)Top', and
  113.      then selects the menu item `Buffers' in the node `(emacs)Top'.
  114. File: info-stnd.info,  Node: Options-Footnotes,  Up: Options
  115. (1)  Of course, you can specify both the file and node in a `--node'
  116. command; but don't forget to escape the open and close parentheses from
  117. the shell as in: `info --node '(emacs)Buffers''
  118. File: info-stnd.info,  Node: Cursor Commands,  Next: Scrolling Commands,  Prev: Options,  Up: Top
  119. Moving the Cursor
  120. *****************
  121. Many people find that reading screens of text page by page is made
  122. easier when one is able to indicate particular pieces of text with some
  123. kind of pointing device.  Since this is the case, GNU Info (both the
  124. Emacs and standalone versions) have several commands which allow you to
  125. move the cursor about the screen.  The notation used in this manual to
  126. describe keystrokes is identical to the notation used within the Emacs
  127. manual, and the GNU Readline manual.  *Note Character Conventions:
  128. (emacs)Characters, if you are unfamiliar with the notation.
  129. The following table lists the basic cursor movement commands in Info.
  130. Each entry consists of the key sequence you should type to execute the
  131. cursor movement, the `M-x'(1) (*note Cursor Commands-Footnotes::)
  132. command name (displayed in parentheses), and a short description of
  133. what the command does.  All of the cursor motion commands can take an
  134. "numeric" argument (*note `universal-argument': Miscellaneous
  135. Commands.), to find out how to supply them.  With a numeric argument,
  136. the motion commands are simply executed that many times; for example, a
  137. numeric argument of 4 given to `next-line' causes the cursor to move
  138. down 4 lines.  With a negative numeric argument, the motion is
  139. reversed; an argument of -4 given to the `next-line' command would
  140. cause the cursor to move *up* 4 lines.
  141. `C-n' (`next-line')
  142.      Move the cursor down to the next line.
  143. `C-p' (`prev-line')
  144.      Move the cursor up to the previous line.
  145. `C-a' (`beginning-of-line')
  146.      Move the cursor to the start of the current line.
  147. `C-e' (`end-of-line')
  148.      Move the cursor to the end of the current line.
  149. `C-f' (`forward-char')
  150.      Move the cursor forward a character.
  151. `C