README revision 93139
193139SruCopyright (C) 1992, 93, 94, 95, 96, 97, 98, 99, 2000, 01, 02 293139SruFree Software Foundation. 393139Sru 493139SruPermission is granted to copy, distribute and/or modify this document 593139Sruunder the terms of the GNU Free Documentation License, Version 1.1 or 693139Sruany later version published by the Free Software Foundation; with no 793139SruInvariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. 893139Sru 993139Sru 1042660SmarkmThis is the README file for the GNU Texinfo distribution. 1193139SruThe primary distribution point is ftp://ftp.gnu.org/gnu/texinfo/ 1293139Sruand the primary home page is http://www.gnu.org/software/texinfo/, 1393139Srusecondary home page at http://texinfo.org/. 1421495Sjmacd 1556160SruMailing lists: 1656160Sru- bug-texinfo@gnu.org for bug reports or enhancement suggestions, 1793139Sru archived at ftp://ftp-mailing-list-archives.gnu.org/bug-texinfo/. 1856160Sru- help-texinfo@gnu.org for authoring questions and general discussion. 1993139Sru archived at ftp://ftp-mailing-list-archives.gnu.org/help-texinfo/. 2093139Sru- texinfo-pretest@texinfo.org for pretests of new releases, 2193139Sru archived at ftp://ftp.texinfo.org/texinfo/texinfo-pretest-archive/. 2256160SruThere are as yet no corresponding newsgroups. 2321495Sjmacd 2456160SruFor bug reports, please include enough information for the maintainers 2556160Sruto reproduce the problem. Generally speaking, that means: 2693139Sru- the contents of any input files necessary to reproduce the bug (crucial!). 2793139Sru- a description of the problem and any samples of the erroneous output. 2856160Sru- the version number of Texinfo and the program(s) involved (use --version). 2956160Sru- hardware, operating system, and compiler versions (uname -a). 3056160Sru- any unusual options you gave to configure (see config.status). 3156160Sru- anything else that you think would be helpful. 3221495Sjmacd 3356160SruPatches are most welcome; if possible, please make them with diff -c and 3456160Sruinclude ChangeLog entries. 3556160Sru 3656160SruWhen sending email, please do not encode or split the messages in any 3793139Sruway if at all possible; it's easier to deal with one large message than 3893139Srumany small ones. GNU shar is a convenient way of packaging multiple 3993139Sruand/or binary files for email. 4056160Sru 4156160Sru 4242660SmarkmFor generic installation instructions on compiling and installing this 4342660SmarkmAutomake-based distribution, please read the file `INSTALL'. 4442660SmarkmInstallation notes specific to Texinfo: 4521495Sjmacd 4656160Sru* The Info tree uses a file `dir' as its root node; the `dir-example' 4756160Sru file in this distribution is included as a possible starting point. 4856160Sru Use it, modify it, or ignore it just as you like. 4921495Sjmacd 5056160Sru* You can create a file texinfo.cnf to be read by TeX when 5156160Sru processing Texinfo manuals. For example, you might like to use 5256160Sru @afourpaper by default. See the `Preparing for TeX' node in 5356160Sru texinfo.txi for more details. You don't have to create the file if 5456160Sru you have nothing to put in it. 5521495Sjmacd 5656160Sru* If your info files are not in $prefix/info, you may wish to add a line 5756160Sru#define DEFAULT_INFOPATH "/mydir1:/mydir2:..." 5856160Sru to config.h after running configure. 5942660Smarkm 6056160Sru* For instructions on compiling this distribution with DJGPP tools 6193139Sru for MS-DOS and MS-Windows, see the file djgpp/README. 6242660Smarkm 6321495Sjmacd 6456160SruIf you would like to contribute to the GNU project by implementing 6556160Sruadditional documentation output formats for Texinfo, that would be 6656160Srugreat. But please do not write a separate translator texi2foo for your 6756160Srufavorite format foo! That is the hard way to do the job, and makes 6856160Sruextra work in subsequent maintenance, since the Texinfo language is 6956160Srucontinually being enhanced and updated. Instead, the best approach is 7093139Srumodify Makeinfo to generate the new format, as it does now for Info, 7193139SruHTML, XML, and DocBook. 7256160Sru 7393139SruIf you want to convert from DocBook to Texinfo, please see 7493139Sruhttp://docbook2X.sourceforge.net/. 7556160Sru 7693139Sru 7756160SruThis distribution includes the following files, among others: 7821495Sjmacd README This file. 7956160Sru 8056160Sru NEWS Summary of new features by release. 8156160Sru 8242660Smarkm INTRODUCTION Brief introduction to the system, and 8342660Smarkm how to create readable files from the 8442660Smarkm Texinfo source files in this distribution. 8521495Sjmacd 8642660SmarkmTexinfo source files (in ./doc): 8756160Sru texinfo.txi Describes the Texinfo language and many 8856160Sru of the associated tools. It tells how 8956160Sru to use Texinfo to write documentation, 9056160Sru how to use Texinfo mode in GNU Emacs, 9156160Sru TeX, makeinfo, and the Emacs Lisp 9256160Sru Texinfo formatting commands. 9321495Sjmacd 9421495Sjmacd info.texi This manual tells you how to use 9521495Sjmacd Info. This document comes as part of 9621495Sjmacd GNU Emacs. If you do not have Emacs, 9721495Sjmacd you can format this Texinfo source 9821495Sjmacd file with makeinfo or TeX and then 9921495Sjmacd read the resulting Info file with the 10021495Sjmacd standalone Info reader that is part of 10121495Sjmacd this distribution. 10221495Sjmacd 10321495Sjmacd info-stnd.texi This manual tells you how to use 10421495Sjmacd the standalone GNU Info reader that is 10542660Smarkm included in this distribution as C 10642660Smarkm source (./info). 10721495Sjmacd 10821495SjmacdPrinting related files: 10942660Smarkm doc/texinfo.tex This TeX definitions file tells 11021495Sjmacd the TeX program how to typeset a 11121495Sjmacd Texinfo file into a DVI file ready for 11221495Sjmacd printing. 11321495Sjmacd 11442660Smarkm util/texindex.c This file contains the source for 11521495Sjmacd the `texindex' program that generates 11621495Sjmacd sorted indices used by TeX when 11721495Sjmacd typesetting a file for printing. 11821495Sjmacd 11942660Smarkm util/texi2dvi This is a shell script for 12021495Sjmacd producing an indexed DVI file using 12156160Sru TeX and texindex. 12221495Sjmacd 12321495Sjmacd 12442660SmarkmSource files for standalone C programs (./lib, ./makeinfo, ./info): 12521495Sjmacd 12656160Sru makeinfo/makeinfo.c This file contains the source for 12721495Sjmacd the `makeinfo' program that you can 12821495Sjmacd use to create an Info file from a 12921495Sjmacd Texinfo file. 13021495Sjmacd 13156160Sru info/info.c This file contains the source for 13221495Sjmacd the `info' program that you can use to 13321495Sjmacd view Info files on an ASCII terminal. 13421495Sjmacd 13542660SmarkmInstallation files: 13621495Sjmacd configure This file creates creates a Makefile 13721495Sjmacd which in turn creates an `info' or 13821495Sjmacd `makeinfo' executable, or a C sources 13921495Sjmacd distribution. 14021495Sjmacd 14121495Sjmacd configure.in This is a template for creating 14242660Smarkm `configure' using Autoconf. 14321495Sjmacd 14421495Sjmacd Makefile.in This is a template for `configure' 14542660Smarkm to use to make a Makefile. Created by 14642660Smarkm Automake. 14721495Sjmacd 14842660Smarkm Makefile.am This is a template for Automake 14942660Smarkm to use to make a Makefile.in. 15042660Smarkm 15121495Sjmacd 15256160SruOther files: 15321495Sjmacd fixfonts This is a shell script to install the 15421495Sjmacd `lcircle10' TeX fonts as an alias for 15521495Sjmacd the `circle10' fonts. In some older 15621495Sjmacd TeX distributions the names are 15721495Sjmacd different. 15821495Sjmacd 15921495Sjmacd tex3patch This handles a bug for version 16021495Sjmacd 3.0 of TeX that does not occur in 16121495Sjmacd more recent versions. 162