home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / info / texi.info-2 (.txt) < prev    next >
GNU Info File  |  1994-12-22  |  51KB  |  975 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: Texinfo Mode,  Next: Beginning a File,  Prev: Overview,  Up: Top
  21. Using Texinfo Mode
  22. ******************
  23.    You may edit a Texinfo file with any text editor you choose.  A
  24. Texinfo file is no different from any other ASCII file.  However, GNU
  25. Emacs comes with a special mode, called Texinfo mode, that provides
  26. Emacs commands and tools to help ease your work.
  27.    This chapter describes features of GNU Emacs' Texinfo mode but not
  28. any features of the Texinfo formatting language.  If you are reading
  29. this manual straight through from the beginning, you may want to skim
  30. through this chapter briefly and come back to it after reading
  31. succeeding chapters which describe the Texinfo formatting language in
  32. detail.
  33. * Menu:
  34. * Texinfo Mode Overview::       How Texinfo mode can help you.
  35. * Emacs Editing::               Texinfo mode adds to GNU Emacs' general
  36.                                   purpose editing features.
  37. * Inserting::                   How to insert frequently used @-commands.
  38. * Showing the Structure::       How to show the structure of a file.
  39. * Updating Nodes and Menus::    How to update or create new nodes and menus.
  40. * Info Formatting::             How to format for Info.
  41. * Printing::                    How to format and print part or all of a file.
  42. * Texinfo Mode Summary::        Summary of all the Texinfo mode commands.
  43. File: texi.info,  Node: Texinfo Mode Overview,  Next: Emacs Editing,  Up: Texinfo Mode
  44. Texinfo Mode Overview
  45. =====================
  46.    Texinfo mode provides special features for working with Texinfo
  47. files:
  48.    * Insert frequently used @commands.
  49.    * Automatically create `@node' lines.
  50.    * Show the structure of a Texinfo source file.
  51.    * Automatically create or update the `Next',
  52.      `Previous', and `Up' pointers of a node.
  53.    * Automatically create or update menus.
  54.    * Automatically create a master menu.
  55.    * Format a part or all of a file for Info.
  56.    * Typeset and print part or all of a file.
  57.    Perhaps the two most helpful features are those for inserting
  58. frequently used @-commands and for creating node pointers and menus.
  59. File: texi.info,  Node: Emacs Editing,  Next: Inserting,  Prev: Texinfo Mode Overview,  Up: Texinfo Mode
  60. The Usual GNU Emacs Editing Commands
  61. ====================================
  62.    In most cases, the usual Text mode commands work the same in Texinfo
  63. mode as they do in Text mode.  Texinfo mode adds new editing commands
  64. and tools to GNU Emacs' general purpose editing features.  The major
  65. difference concerns filling.  In Texinfo mode, the paragraph separation
  66. variable and syntax table are redefined so that Texinfo commands that
  67. should be on lines of their own are not inadvertently included in
  68. paragraphs.  Thus, the `M-q' (`fill-paragraph') command will refill a
  69. paragraph but not mix an indexing command on a line adjacent to it into
  70. the paragraph.
  71.    In addition, Texinfo mode sets the `page-delimiter' variable to the
  72. value of `texinfo-chapter-level-regexp'; by default, this is a regular
  73. expression matching the commands for chapters and their equivalents,
  74. such as appendices.  With this value for the page delimiter, you can
  75. jump from chapter title to chapter title with the `C-x ]'
  76. (`forward-page') and `C-x [' (`backward-page') commands and narrow to a
  77. chapter with the `C-x p' (`narrow-to-page') command.  (*Note Pages:
  78. (emacs)Pages, for details about the page commands.)
  79.    You may name a Texinfo file however you wish, but the convention is
  80. to end a Texinfo file name with one of the three extensions `.texinfo',
  81. `.texi', or `.tex'.  A longer extension is preferred, since it is
  82. explicit, but a shorter extension may be necessary for operating
  83. systems that limit the length of file names.  GNU Emacs automatically
  84. enters Texinfo mode when you visit a file with a `.texinfo' or  `.texi'
  85. extension.  Also, Emacs switches to Texinfo mode when you visit a file
  86. that has `-*-texinfo-*-' in its first line.  If ever you are in another
  87. mode and wish to switch to Texinfo mode, type `M-x texinfo-mode'.
  88.    Like all other Emacs features, you can customize or enhance Texinfo
  89. mode as you wish.  In particular, the keybindings are very easy to
  90. change.  The keybindings described here are the default or standard
  91. ones.
  92. File: texi.info,  Node: Inserting,  Next: Showing the Structure,  Prev: Emacs Editing,  Up: Texinfo Mode
  93. Inserting Frequently Used Commands
  94. ==================================
  95.    Texinfo mode provides commands to insert various frequently used
  96. @-commands into the buffer.  You can use these commands to save
  97. keystrokes.
  98.    The insert commands are invoked by typing `C-c' twice and then the
  99. first letter of the @-command:
  100. `C-c C-c c'
  101. `M-x texinfo-insert-@code'
  102.      Insert `@code{}' and put the cursor between the braces.
  103. `C-c C-c d'
  104. `M-x texinfo-insert-@dfn'
  105.      Insert `@dfn{}' and put the cursor between the braces.
  106. `C-c C-c e'
  107. `M-x texinfo-insert-@end'
  108.      Insert `@end' and attempt to insert the correct following word,
  109.      such as `example' or `table'.  (This command does not handle
  110.      nested lists correctly, but inserts the word appropriate to the
  111.      immediately preceding list.)
  112. `C-c C-c i'
  113. `M-x texinfo-insert-@item'
  114.      Insert `@item' and put the cursor at the beginning of the next
  115.      line.
  116. `C-c C-c k'
  117. `M-x texinfo-insert-@kbd'
  118.      Insert `@kbd{}' and put the cursor between the braces.
  119. `C-c C-c n'
  120. `M-x texinfo-insert-@node'
  121.      Insert `@node' and a comment line listing the sequence for the
  122.      `Next', `Previous', and `Up' nodes.  Leave point after the `@node'.
  123. `C-c C-c o'
  124. `M-x texinfo-insert-@noindent'
  125.      Insert `@noindent' and put the cursor at the beginning of the next
  126.      line.
  127. `C-c C-c s'
  128. `M-x texinfo-insert-@samp'
  129.      Insert `@samp{}' and put the cursor between the braces.
  130. `C-c C-c t'
  131. `M-x texinfo-insert-@table'
  132.      Insert `@table' followed by a SPC and leave the cursor after the
  133.      SPC.
  134. `C-c C-c v'
  135. `M-x texinfo-insert-@var'
  136.      Insert `@var{}' and put the cursor between the braces.
  137. `C-c C-c x'
  138. `M-x texinfo-insert-@example'
  139.      Insert `@example' and put the cursor at the beginning of the next
  140.      line.
  141. `C-c C-c {'
  142. `M-x texinfo-insert-braces'
  143.      Insert `{}' and put the cursor between the braces.
  144. `C-c C-c }'
  145. `C-c C-c ]'
  146. `M-x up-list'
  147.      Move from between a pair of braces forward past the closing brace.
  148.      Typing `C-c C-c ]' is easier than typing `C-c C-c }', which is,
  149.      however, more mnemonic; hence the two keybindings.  (Also, you can
  150.      move out from between braces by typing `C-f'.)
  151.    To put a command such as `@code{...}' around an *existing* word,
  152. position the cursor in front of the word and type `C-u 1 C-c C-c c'.
  153. This makes it easy to edit existing plain text.  The value of the
  154. prefix argument tells Emacs how many words following point to include
  155. between braces--1 for one word, 2 for two words, and so on.  Use a
  156. negative argument to enclose the previous word or words.  If you do not
  157. specify a prefix argument, Emacs inserts the @-command string and
  158. positions the cursor between the braces.  This feature works only for
  159. those @-commands that operate on a word or words within one line, such
  160. as `@kbd