README revision 42660
1This is the README file for the GNU Texinfo distribution. 2The primary distribution point is ftp://ftp.gnu.org/pub/gnu. 3 4Please email bugs or suggestions to bug-texinfo@gnu.org. (If you wish, 5you can join this list by sending a subscribe message to 6bug-texinfo-request@gnu.org.) Patches are welcome; if possible, please 7make them with diff -c and include ChangeLog entries. 8 9Programs within this distribution have their own version numbers. When 10you refer to a file, please mention its own version, as well as the 11version number of the Texinfo distribution. 12 13For generic installation instructions on compiling and installing this 14Automake-based distribution, please read the file `INSTALL'. 15Installation notes specific to Texinfo: 16 17 * The Info tree uses a file `dir' as its root node; the `dir-example' 18 file in this distribution is included for informative purposes. 19 Use it, modify it, or ignore it just as you like. 20 21 * You can create a file texinfo.cnf to be read by TeX when 22 processing Texinfo manuals. For example, it might contain the 23 command @afourpaper. See the `Preparing for TeX' node in 24 texinfo.texi for more details. 25 26 * If your info files are not in $prefix/info, you may wish to add a line 27#define DEFAULT_INFOPATH "/mydir1:/mydir2:/etc" 28 to config.h after running configure. 29 30 31This distribution includes (but is not limited to) the following files: 32 33 README This file. 34 INTRODUCTION Brief introduction to the system, and 35 how to create readable files from the 36 Texinfo source files in this distribution. 37 38Texinfo source files (in ./doc): 39 40 texinfo.texi This manual describes the Texinfo language 41 and many of the associated tools. It 42 tells how to use Texinfo to write 43 documentation, how to use Texinfo mode 44 in GNU Emacs, TeX, makeinfo, and the 45 Emacs Lisp Texinfo formatting commands. 46 47 info.texi This manual tells you how to use 48 Info. This document comes as part of 49 GNU Emacs. If you do not have Emacs, 50 you can format this Texinfo source 51 file with makeinfo or TeX and then 52 read the resulting Info file with the 53 standalone Info reader that is part of 54 this distribution. 55 56 info-stnd.texi This manual tells you how to use 57 the standalone GNU Info reader that is 58 included in this distribution as C 59 source (./info). 60 61Printing related files: 62 63 doc/texinfo.tex This TeX definitions file tells 64 the TeX program how to typeset a 65 Texinfo file into a DVI file ready for 66 printing. 67 68 util/texindex.c This file contains the source for 69 the `texindex' program that generates 70 sorted indices used by TeX when 71 typesetting a file for printing. 72 73 util/texi2dvi This is a shell script for 74 producing an indexed DVI file using 75 TeX and texindex. Must be used if the 76 source document uses Texinfo @macros. 77 78 79Source files for standalone C programs (./lib, ./makeinfo, ./info): 80 81 makeinfo.c This file contains the source for 82 the `makeinfo' program that you can 83 use to create an Info file from a 84 Texinfo file. 85 86 info.c This file contains the source for 87 the `info' program that you can use to 88 view Info files on an ASCII terminal. 89 90 getopt.c Various support files 91 getopt1.c 92 getopt.h 93 94 95Installation files: 96 97 configure This file creates creates a Makefile 98 which in turn creates an `info' or 99 `makeinfo' executable, or a C sources 100 distribution. 101 102 configure.in This is a template for creating 103 `configure' using Autoconf. 104 105 Makefile.in This is a template for `configure' 106 to use to make a Makefile. Created by 107 Automake. 108 109 Makefile.am This is a template for Automake 110 to use to make a Makefile.in. 111 112 113Other files (util): 114 115 NEWS This contains a summary of new 116 features since the first edition 117 of Texinfo. 118 119 fixfonts This is a shell script to install the 120 `lcircle10' TeX fonts as an alias for 121 the `circle10' fonts. In some older 122 TeX distributions the names are 123 different. 124 125 tex3patch This handles a bug for version 126 3.0 of TeX that does not occur in 127 more recent versions. 128