home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / gnu / texinfo-3.1-bin.lha / info / texi.info-1 (.txt) < prev    next >
GNU Info File  |  1994-07-11  |  51KB  |  884 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: Top,  Next: Copying,  Prev: (dir),  Up: (dir)
  21. Texinfo
  22. *******
  23.    Texinfo is a documentation system that uses a single source file to
  24. produce both on-line information and printed output.
  25.    The first part of this master menu lists the major nodes in this Info
  26. document, including the @-command and concept indices.  The rest of the
  27. menu lists all the lower level nodes in the document.
  28.    This is Edition 2.18 of the Texinfo documentation, 26 March 1993,
  29. for Texinfo Version 2.
  30. * Menu:
  31. * Copying::                     Your rights.
  32. * Overview::                    Texinfo in brief.
  33. * Texinfo Mode::                How to use Texinfo mode.
  34. * Beginning a File::            What is at the beginning of a Texinfo file?
  35. * Ending a File::               What is at the end of a Texinfo file?
  36. * Structuring::                 How to create chapters, sections, subsections,
  37.                                   appendices, and other parts.
  38. * Nodes::                       How to write nodes.
  39. * Menus::                       How to write menus.
  40. * Cross References::            How to write cross references.
  41. * Marking Text::                How to mark words and phrases as code,
  42.                                   keyboard input, meta-syntactic
  43.                                   variables, and the like.
  44. * Quotations and Examples::     How to write quotations, examples, etc.
  45. * Lists and Tables::            How to write lists and tables.
  46. * Indices::                     How to create indices.
  47. * Insertions::                  How to insert @-signs, braces, etc.
  48. * Glyphs::                      How to indicate results of evaluation,
  49.                                   expansion of macros, errors, etc.
  50. * Breaks::                      How to force and prevent line and page breaks.
  51. * Definition Commands::         How to describe functions and the like
  52.                                   in a uniform manner.
  53. * Footnotes::                   How to write footnotes.
  54. * Conditionals::                How to specify text for either TeX or Info.
  55. * Format/Print Hardcopy::       How to convert a Texinfo file to a file
  56.                                   for printing and how to print that file.
  57. * Create an Info File::         Convert a Texinfo file into an Info file.
  58. * Install an Info File::        Make an Info file accessible to users.
  59. * Command List::                All the Texinfo @-commands.
  60. * Tips::                        Hints on how to write a Texinfo document.
  61. * Sample Texinfo File::         A sample Texinfo file to look at.
  62. * Sample Permissions::          Tell readers they have the right to copy
  63.                                   and distribute.
  64. * Include Files::               How to incorporate other Texinfo files.
  65. * Headings::                    How to write page headings and footings.
  66. * Catching Mistakes::           How to find formatting mistakes.
  67. * Refilling Paragraphs::        All about paragraph refilling.
  68. * Command Syntax::              A description of @-Command syntax.
  69. * Obtaining TeX::               How to Obtain TeX.
  70. * New Features::                Texinfo second edition features.
  71. * Command and Variable Index::  A menu containing commands and variables.
  72. * Concept Index::               A menu covering many topics.
  73.  -- The Detailed Node Listing --
  74. Overview of Texinfo
  75. * Using Texinfo::               Create a conventional printed book
  76.                                   or an Info file.
  77. * Info Files::                  What is an Info file?
  78. * Printed Books::               Characteristics of a printed book or manual.
  79. * Formatting Commands::         @-commands are used for formatting.
  80. * Conventions::                 General rules for writing a Texinfo file.
  81. * Comments::                    How to write comments and mark regions that
  82.                                   the formatting commands will ignore.
  83. * Minimum::                     What a Texinfo file must have.
  84. * Six Parts::                   Usually, a Texinfo file has six parts.
  85. * Short Sample::                A short sample Texinfo file.
  86. * Acknowledgements::
  87. Using Texinfo Mode
  88. * Texinfo Mode Overview::       How Texinfo mode can help you.
  89. * Emacs Editing::               Texinfo mode adds to GNU Emacs' general
  90.                                   purpose editing features.
  91. * Inserting::                   How to insert frequently used @-commands.
  92. * Showing the Structure::       How to show the structure of a file.
  93. * Updating Nodes and Menus::    How to update or create new nodes and menus.
  94. * Info Formatting::             How to format for Info.
  95. * Printing::                    How to format and print part or all of a file.
  96. * Texinfo Mode Summary::        Summary of all the Texinfo mode commands.
  97. Updating Nodes and Menus
  98. * Updating Commands::           Five major updating commands.
  99. * Updating Requirements::       How to structure a Texinfo file for
  100.                                   using the updating command.
  101. * Other Updating Commands::     How to indent descriptions, insert
  102.                                   missing nodes lines, and update
  103.                                   nodes in sequence.
  104. Beginning a Texinfo File
  105. * Four Parts::                  Four parts begin a Texinfo file.
  106. * Sample Beginning::            Here is a sample beginning for a Texinfo file.
  107. * Header::                      The very beginning of a Texinfo file.
  108. * Info Summary and Permissions::  Summary and copying permissions for Info.
  109. * Titlepage & Copyright Page::  Creating the title and copyright pages.
  110. * The Top Node::                Creating the `Top' node and master menu.
  111. * Software Copying Permissions::  Ensure that you and others continue to
  112.                                   have the right to use and share software.
  113. The Texinfo File Header
  114. * First Line::                  The first line of a Texinfo file.
  115. * Start of Header::             Formatting a region requires this.
  116. * setfilename::                 Tell Info the name of the Info file.
  117. * settitle::                    Create a title for the printed work.
  118. * setchapternewpage::           Start chapters on right-hand pages.
  119. * paragraphindent::             An option to specify paragraph indentation.
  120. * End of Header::               Formatting a region requires this.
  121. The Title and Copyright Pages
  122. * titlepage::                   Create a title for the printed document.
  123. * titlefont center sp::         The `@titlefont', `@center',
  124.                                   and `@sp' commands.
  125. * title subtitle author::       The `@title', `@subtitle',
  126.                                   and `@author' commands.
  127. * Copyright & Permissions::     How to write the copyright notice and
  128.                                   include copying permissions.
  129. * end titlepage::               Turn on page headings after the title and
  130.                                   copyright pages.
  131. * headings on off::             An option for turning headings on and off
  132.                                   and double or single sided printing.
  133. The `Top' Node and Master Menu
  134. * Title of Top Node::           Sketch what the file is about.
  135. * Master Menu Parts::           A master menu has three o