home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / OS2 / gnuinfo.zip / README < prev    next >
Text File  |  1997-07-29  |  7KB  |  161 lines
  1. This is the README file for the GNU Texinfo distribution.
  2.  
  3. Please email bugs or suggestions to bug-texinfo@prep.ai.mit.edu.
  4.  
  5. Files within this distribution have their own version and edition
  6. numbers.  When you refer to a file, please mention its own version, as
  7. well as the version number of the Texinfo distribution.
  8.  
  9. For instructions on compiling and installing info, makeinfo, texi2dvi,
  10. and texindex, please read the file `INSTALL'.  Also:
  11.  
  12.     * The Emacs Lisp files are not compiled or installed by default; to
  13.       install them, use `make install' in the `emacs' subdirectory.  See
  14.       ./emacs/README for some considerations.
  15.  
  16.     * The Info tree uses a file `dir' as its root node; the `dir-example'
  17.       file in this distribution is included for informative purposes.
  18.       Use it or not as you like.
  19.  
  20.     * You can create a file texinfo.cnf to be read by TeX when
  21.       processing Texinfo manuals.  For example, it might contain the
  22.       command @afourpaper.  See the `Preparing for TeX' node in
  23.       texinfo.texi for more details.
  24.  
  25.  
  26. Texinfo is a documentation system that uses a single source file to
  27. produce both online information and printed output.  This means that
  28. instead of writing two different documents, one for the online help or
  29. other online information and the other for a typeset manual or other
  30. printed work, you need write only one document.  When the work is
  31. revised, you need revise only one document.  You can read the online
  32. information, known as an "Info file", with an Info documentation-reading
  33. program.  By convention, Texinfo source file names end with a `.texi' or
  34. `.texinfo' extension.  Texinfo is described in the Texinfo manual (the
  35. file ./doc/texinfo.texi).
  36.  
  37. You can write and format Texinfo files into Info files within GNU Emacs,
  38. and read them using the Emacs Info reader.  If you do not have Emacs,
  39. you can format Texinfo files into Info files using `makeinfo' and read
  40. them using `info'.  Use TeX, which is not included in this package (see
  41. `How to Obtain TeX' in the Texinfo manual for information), to typeset
  42. Texinfo files for printing.
  43.  
  44.  
  45. This distribution includes (but is not limited to) the following files:
  46.  
  47.     README                      This file.
  48.     INTRODUCTION                This file tells you how to create
  49.                                 readable files from the Texinfo source
  50.                                 files in this distribution.
  51.  
  52. Texinfo source files (in ./doc):
  53.  
  54.     texinfo.texi                This manual describes Texinfo.  It
  55.                                 tells how to use Texinfo to write
  56.                                 documentation, how to use Texinfo mode
  57.                                 in GNU Emacs, how to use TeX,
  58.                                 makeinfo, and the Emacs Lisp Texinfo
  59.                                 formatting commands.
  60.  
  61.     info.texi                   This manual tells you how to use 
  62.                                 Info.  This document comes as part of
  63.                                 GNU Emacs.  If you do not have Emacs,
  64.                                 you can format this Texinfo source
  65.                                 file with makeinfo or TeX and then
  66.                                 read the resulting Info file with the
  67.                                 standalone Info reader that is part of
  68.                                 this distribution.
  69.  
  70.     info-stnd.texi              This manual tells you how to use
  71.                                 the standalone GNU Info reader that is
  72.                                 included in this distribution as C
  73.                                 source (./info).
  74.  
  75. Printing related files:
  76.  
  77.     texinfo.tex                 This TeX definitions file tells
  78.                                 the TeX program how to typeset a
  79.                                 Texinfo file into a DVI file ready for
  80.                                 printing.
  81.  
  82.     util/texindex.c             This file contains the source for
  83.                                 the `texindex' program that generates
  84.                                 sorted indices used by TeX when
  85.                                 typesetting a file for printing.
  86.  
  87.     util/texi2dvi               This is a shell script for
  88.                                 producing an indexed DVI file using
  89.                                 TeX and texindex. Must be used if the
  90.                                 source document uses Texinfo @macros.
  91.  
  92.  
  93. GNU Emacs related files (in ./emacs):
  94.  
  95.     texinfmt.el                 This Emacs Lisp file provides the
  96.                                 functions that GNU Emacs uses to
  97.                                 format a Texinfo file into an Info
  98.                                 file.
  99.  
  100.     texinfo.el                  This file provides Texinfo mode
  101.                                 for GNU Emacs.
  102.  
  103.     texnfo-upd.el               These files provides commands to
  104.     makeinfo.el                 help you write Texinfo files
  105.                                 using GNU Emacs Texinfo mode.
  106.  
  107.     info.el                     These are the standard GNU Emacs
  108.     informat.el                 Info reading and support files,
  109.                                 included here for your convenience.
  110.  
  111.  
  112. Source files for standalone C programs (./lib, ./makeinfo, ./info):
  113.  
  114.     makeinfo.c                  This file contains the source for
  115.                                 the `makeinfo' program that you can
  116.                                 use to create an Info file from a
  117.                                 Texinfo file.
  118.  
  119.     info.c                      This file contains the source for
  120.                                 the `info' program that you can use to
  121.                                 view Info files on an ASCII terminal.
  122.  
  123.     getopt.c                    Various support files
  124.     getopt1.c
  125.     getopt.h
  126.  
  127.  
  128. Installation files:
  129.  
  130.     configure                   This file creates creates a Makefile 
  131.                                 which in turn creates an `info' or
  132.                                 `makeinfo' executable, or a C sources
  133.                                 distribution.
  134.  
  135.     configure.in                This is a template for creating 
  136.                                 `configure' using Autoconf.
  137.  
  138.     Makefile.in                 This is a template for `configure' 
  139.                                 to use to make a Makefile.  Created by
  140.                                 Automake.
  141.                                
  142.     Makefile.am                 This is a template for Automake
  143.                                 to use to make a Makefile.in.
  144.                                
  145.  
  146. Other files:
  147.  
  148.     NEWS                        This contains a summary of new
  149.                                 features since the first edition 
  150.                                 of Texinfo.
  151.  
  152.     fixfonts                    This is a shell script to install the 
  153.                                 `lcircle10' TeX fonts as an alias for
  154.                                 the `circle10' fonts.  In some older
  155.                                 TeX distributions the names are
  156.                                 different.
  157.  
  158.     tex3patch                   This handles a bug for version
  159.                                 3.0 of TeX that does not occur in
  160.                                 more recent versions.
  161.