home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / texinfo-3.7-src.tgz / tar.out / fsf / texinfo / README < prev    next >
Text File  |  1996-09-28  |  7KB  |  162 lines
  1. Texinfo, Version 3
  2. ==================
  3.  
  4. This is the README file for version 3 of the Texinfo distribution.
  5. Files within this distribution have their own version and edition
  6. numbers.  When you refer to a file, please mention its own number.
  7.  
  8. PLEASE REPORT BUGS TO: bug-texinfo@prep.ai.mit.edu
  9.  
  10. 23 March 1993
  11.  
  12. Texinfo is a documentation system that uses a single source file to
  13. produce both on-line information and printed output.  This means that
  14. instead of writing two different documents, one for the on-line help
  15. or other on-line information and the other for a typeset manual or
  16. other printed work, you need write only one document.  When the work
  17. is revised, you need revise only one document.  You can read the
  18. on-line information, known as an "Info file", with an Info
  19. documentation-reading program.  By convention, Texinfo source file
  20. names end with a `.texi' or `.texinfo' extension.  Texinfo is
  21. described in the Texinfo Manual.
  22.  
  23. You can write and format Texinfo files into Info files within GNU
  24. Emacs, and read them using the Emacs Info reader.  If you do not have
  25. Emacs, you can format Texinfo files into Info files using `makeinfo'
  26. and read them using `info'.  Use TeX, which is not included in this
  27. package, to typeset Texinfo files for printing.
  28.  
  29. For instructions on installing info, makeinfo, texi2dvi, and texindex,
  30. please read the file `INSTALL'.  The Emacs Lisp files are not
  31. installed by default; to install them, use `make install' in the
  32. `emacs' subdirectory.
  33.  
  34. This distribution includes (but is not limited to) the following files:
  35.  
  36.     README                      This file.
  37.  
  38.     INTRODUCTION                This file tells you how to create
  39.                                 readable files from the Texinfo source
  40.                                 files in this distribution.
  41.  
  42. Texinfo source files:
  43.  
  44.     texinfo.texi                This manual describes Texinfo.  It
  45.                                 tells how to use Texinfo to write
  46.                                 documentation, how to use Texinfo mode
  47.                                 in GNU Emacs, how to use TeX,
  48.                                 makeinfo, and the Emacs Lisp Texinfo
  49.                                 formatting commands.
  50.  
  51.     info.texi                   This manual tells you how to use 
  52.                                 Info.  This document comes as part of
  53.                                 GNU Emacs.  If you do not have Emacs,
  54.                                 you can format this Texinfo source
  55.                                 file with makeinfo or TeX and then
  56.                                 read the resulting Info file with the
  57.                                 standalone Info reader that is part of
  58.                                 this distribution.
  59.  
  60.     info-stnd.texi              This manual tells you how to use
  61.                                 the standalone GNU Info reader that is
  62.                                 included in this distribution as a C
  63.                                 source file, `info.c'.
  64.  
  65.     makeinfo.texi               This manual tells you how to use
  66.                                 makeinfo.  The same information is
  67.                                 contained in a chapter of the Texinfo
  68.                                 manual; it has been extracted here for
  69.                                 your convenience.
  70.  
  71.  
  72. Printing related files:
  73.  
  74.     texinfo.tex                 This TeX definitions file tells
  75.                                 the TeX program how to typeset a
  76.                                 Texinfo file into a DVI file ready for
  77.                                 printing.
  78.  
  79.     texindex.c                  This file contains the source for
  80.                                 the `texindex' program that generates
  81.                                 sorted indices used by TeX when
  82.                                 typesetting a file for printing.
  83.  
  84.     texi2dvi                    This is a shell script for
  85.                                 producing an indexed DVI file using
  86.                                 TeX and texindex.
  87.  
  88.  
  89. GNU Emacs related files:
  90.  
  91.     texinfmt.el                 This Emacs Lisp file provides the
  92.                                 functions that GNU Emacs uses to
  93.                                 format a Texinfo file into an Info
  94.                                 file.
  95.  
  96.     texinfo.el                  This file provides Texinfo mode
  97.                                 for GNU Emacs.
  98.  
  99.     texnfo-upd.el               These files provides commands to
  100.     texnfo-tex.el               help you write Texinfo files
  101.     makeinfo.el                 using GNU Emacs Texinfo mode.
  102.  
  103.     detexinfo.el                This extra utility file contains functions 
  104.                                 to remove Texinfo commands from a
  105.                                 Texinfo source file.
  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:
  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. C 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 m4 macros.
  137.  
  138.     Makefile.in                 This is a template for `configure' 
  139.                                 to use to make a Makefile.
  140.                                
  141.  
  142. Other files:
  143.  
  144.     NEWS                        This contains a summary of new
  145.                                 features since the first edition 
  146.                                 of Texinfo.
  147.  
  148.     info.1                      This is a `man' page that briefly 
  149.                                 describes the standalone `info'
  150.                                 program.
  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.  
  162.