README revision 21495
121495SjmacdTexinfo, Version 3 221495Sjmacd================== 321495Sjmacd 421495SjmacdThis is the README file for version 3 of the Texinfo distribution. 521495SjmacdFiles within this distribution have their own version and edition 621495Sjmacdnumbers. When you refer to a file, please mention its own number, as 721495Sjmacdwell as the version number of the Texinfo distribution. 821495Sjmacd 921495SjmacdPLEASE REPORT BUGS TO: bug-texinfo@prep.ai.mit.edu 1021495Sjmacd 1121495SjmacdTexinfo is a documentation system that uses a single source file to 1221495Sjmacdproduce both on-line information and printed output. This means that 1321495Sjmacdinstead of writing two different documents, one for the on-line help 1421495Sjmacdor other on-line information and the other for a typeset manual or 1521495Sjmacdother printed work, you need write only one document. When the work 1621495Sjmacdis revised, you need revise only one document. You can read the 1721495Sjmacdon-line information, known as an "Info file", with an Info 1821495Sjmacddocumentation-reading program. By convention, Texinfo source file 1921495Sjmacdnames end with a `.texi' or `.texinfo' extension. Texinfo is 2021495Sjmacddescribed in the Texinfo manual (the file ./texinfo.texi). 2121495Sjmacd 2221495SjmacdYou can write and format Texinfo files into Info files within GNU Emacs, 2321495Sjmacdand read them using the Emacs Info reader. If you do not have Emacs, 2421495Sjmacdyou can format Texinfo files into Info files using `makeinfo' and read 2521495Sjmacdthem using `info'. Use TeX, which is not included in this package (see 2621495Sjmacd`How to Obtain TeX' in the Texinfo manual for information), to typeset 2721495SjmacdTexinfo files for printing. 2821495Sjmacd 2921495SjmacdFor instructions on compiling and installing info, makeinfo, texi2dvi, 3021495Sjmacdand texindex, please read the file `INSTALL'. The Emacs Lisp files are 3121495Sjmacdnot installed by default; to install them, use `make install' in the 3221495Sjmacd`emacs' subdirectory. The Info tree uses a file `dir' as its root node; 3321495Sjmacda sample `dir' file is included in the distribution, but not installed 3421495Sjmacdanywhere. Use it or not as you like. 3521495Sjmacd 3621495SjmacdThis distribution includes (but is not limited to) the following files: 3721495Sjmacd 3821495Sjmacd README This file. 3921495Sjmacd 4021495Sjmacd INTRODUCTION This file tells you how to create 4121495Sjmacd readable files from the Texinfo source 4221495Sjmacd files in this distribution. 4321495Sjmacd 4421495SjmacdTexinfo source files: 4521495Sjmacd 4621495Sjmacd texinfo.texi This manual describes Texinfo. It 4721495Sjmacd tells how to use Texinfo to write 4821495Sjmacd documentation, how to use Texinfo mode 4921495Sjmacd in GNU Emacs, how to use TeX, 5021495Sjmacd makeinfo, and the Emacs Lisp Texinfo 5121495Sjmacd formatting commands. 5221495Sjmacd 5321495Sjmacd info.texi This manual tells you how to use 5421495Sjmacd Info. This document comes as part of 5521495Sjmacd GNU Emacs. If you do not have Emacs, 5621495Sjmacd you can format this Texinfo source 5721495Sjmacd file with makeinfo or TeX and then 5821495Sjmacd read the resulting Info file with the 5921495Sjmacd standalone Info reader that is part of 6021495Sjmacd this distribution. 6121495Sjmacd 6221495Sjmacd info-stnd.texi This manual tells you how to use 6321495Sjmacd the standalone GNU Info reader that is 6421495Sjmacd included in this distribution as a C 6521495Sjmacd source file, `info.c'. 6621495Sjmacd 6721495Sjmacd makeinfo.texi This manual tells you how to use 6821495Sjmacd makeinfo. The same information is 6921495Sjmacd contained in a chapter of the Texinfo 7021495Sjmacd manual; it has been extracted here for 7121495Sjmacd your convenience. 7221495Sjmacd 7321495Sjmacd 7421495SjmacdPrinting related files: 7521495Sjmacd 7621495Sjmacd texinfo.tex This TeX definitions file tells 7721495Sjmacd the TeX program how to typeset a 7821495Sjmacd Texinfo file into a DVI file ready for 7921495Sjmacd printing. 8021495Sjmacd 8121495Sjmacd texindex.c This file contains the source for 8221495Sjmacd the `texindex' program that generates 8321495Sjmacd sorted indices used by TeX when 8421495Sjmacd typesetting a file for printing. 8521495Sjmacd 8621495Sjmacd texi2dvi This is a shell script for 8721495Sjmacd producing an indexed DVI file using 8821495Sjmacd TeX and texindex. Must be used if the 8921495Sjmacd source document uses Texinfo @macros. 9021495Sjmacd 9121495Sjmacd 9221495SjmacdGNU Emacs related files: 9321495Sjmacd 9421495Sjmacd texinfmt.el This Emacs Lisp file provides the 9521495Sjmacd functions that GNU Emacs uses to 9621495Sjmacd format a Texinfo file into an Info 9721495Sjmacd file. 9821495Sjmacd 9921495Sjmacd texinfo.el This file provides Texinfo mode 10021495Sjmacd for GNU Emacs. 10121495Sjmacd 10221495Sjmacd texnfo-upd.el These files provides commands to 10321495Sjmacd texnfo-tex.el help you write Texinfo files 10421495Sjmacd makeinfo.el using GNU Emacs Texinfo mode. 10521495Sjmacd 10621495Sjmacd detexinfo.el This extra utility file contains functions 10721495Sjmacd to remove Texinfo commands from a 10821495Sjmacd Texinfo source file. 10921495Sjmacd 11021495Sjmacd info.el These are the standard GNU Emacs 11121495Sjmacd informat.el Info reading and support files, 11221495Sjmacd included here for your convenience. 11321495Sjmacd 11421495Sjmacd 11521495SjmacdSource files for standalone C programs: 11621495Sjmacd 11721495Sjmacd makeinfo.c This file contains the source for 11821495Sjmacd the `makeinfo' program that you can 11921495Sjmacd use to create an Info file from a 12021495Sjmacd Texinfo file. 12121495Sjmacd 12221495Sjmacd info.c This file contains the source for 12321495Sjmacd the `info' program that you can use to 12421495Sjmacd view Info files on an ASCII terminal. 12521495Sjmacd 12621495Sjmacd getopt.c Various support files 12721495Sjmacd getopt1.c 12821495Sjmacd getopt.h 12921495Sjmacd 13021495Sjmacd 13121495SjmacdC Installation files: 13221495Sjmacd 13321495Sjmacd configure This file creates creates a Makefile 13421495Sjmacd which in turn creates an `info' or 13521495Sjmacd `makeinfo' executable, or a C sources 13621495Sjmacd distribution. 13721495Sjmacd 13821495Sjmacd configure.in This is a template for creating 13921495Sjmacd `configure' using m4 macros. 14021495Sjmacd 14121495Sjmacd Makefile.in This is a template for `configure' 14221495Sjmacd to use to make a Makefile. 14321495Sjmacd 14421495Sjmacd 14521495SjmacdOther files: 14621495Sjmacd 14721495Sjmacd NEWS This contains a summary of new 14821495Sjmacd features since the first edition 14921495Sjmacd of Texinfo. 15021495Sjmacd 15121495Sjmacd info.1 This is a `man' page that briefly 15221495Sjmacd describes the standalone `info' 15321495Sjmacd program. 15421495Sjmacd 15521495Sjmacd fixfonts This is a shell script to install the 15621495Sjmacd `lcircle10' TeX fonts as an alias for 15721495Sjmacd the `circle10' fonts. In some older 15821495Sjmacd TeX distributions the names are 15921495Sjmacd different. 16021495Sjmacd 16121495Sjmacd tex3patch This handles a bug for version 16221495Sjmacd 3.0 of TeX that does not occur in 16321495Sjmacd more recent versions. 164