README revision 56160
11590SrgrimesThis is the README file for the GNU Texinfo distribution. 287763SmarkmThe primary distribution point is ftp://ftp.gnu.org/gnu/texinfo/. 31590Srgrimes 41590SrgrimesMailing lists: 587763Smarkm- bug-texinfo@gnu.org for bug reports or enhancement suggestions, 61590Srgrimes archived at ftp://ftp-mailing-list-archives.gnu.org/. 71590Srgrimes- help-texinfo@gnu.org for authoring questions and general discussion. 8 archived at the same place. 9- texinfo-pretest@tug.org for pretests of new releases, 10 archived at http://tug.org/archives/texinfo-pretest/. 11There are as yet no corresponding newsgroups. 12 13For bug reports, please include enough information for the maintainers 14to reproduce the problem. Generally speaking, that means: 15- the version number of Texinfo and the program(s) involved (use --version). 16- hardware, operating system, and compiler versions (uname -a). 17- any unusual options you gave to configure (see config.status). 18- the contents of any input files necessary to reproduce the bug (crucial!). 19- a description of the problem and any samples of the erroneous output. 20- anything else that you think would be helpful. 21 22Patches are most welcome; if possible, please make them with diff -c and 23include ChangeLog entries. 24 25When sending email, please do not encode or split the messages in any 26way if at all possible; it's much easier to deal with one large message 27than many small ones. GNU shar is a convenient way of packaging 28multiple and/or binary files for email. 29 30 31For generic installation instructions on compiling and installing this 32Automake-based distribution, please read the file `INSTALL'. 33Installation notes specific to Texinfo: 34 35* The Info tree uses a file `dir' as its root node; the `dir-example' 36 file in this distribution is included as a possible starting point. 37 Use it, modify it, or ignore it just as you like. 38 39* You can create a file texinfo.cnf to be read by TeX when 40 processing Texinfo manuals. For example, you might like to use 41 @afourpaper by default. See the `Preparing for TeX' node in 42 texinfo.txi for more details. You don't have to create the file if 43 you have nothing to put in it. 44 45* If your info files are not in $prefix/info, you may wish to add a line 46#define DEFAULT_INFOPATH "/mydir1:/mydir2:..." 47 to config.h after running configure. 48 49* For instructions on compiling this distribution with DJGPP tools 50 for MS-DOS and MS-Windows, please see the file djgpp/README. 51 52 53If you would like to contribute to the GNU project by implementing 54additional documentation output formats for Texinfo, that would be 55great. But please do not write a separate translator texi2foo for your 56favorite format foo! That is the hard way to do the job, and makes 57extra work in subsequent maintenance, since the Texinfo language is 58continually being enhanced and updated. Instead, the best approach is 59modify Makeinfo to generate the new format, as it does now for Info and HTML. 60 61 62This distribution includes the following files, among others: 63 64 README This file. 65 66 NEWS Summary of new features by release. 67 68 INTRODUCTION Brief introduction to the system, and 69 how to create readable files from the 70 Texinfo source files in this distribution. 71 72Texinfo source files (in ./doc): 73 74 texinfo.txi Describes the Texinfo language and many 75 of the associated tools. It tells how 76 to use Texinfo to write documentation, 77 how to use Texinfo mode in GNU Emacs, 78 TeX, makeinfo, and the Emacs Lisp 79 Texinfo formatting commands. 80 81 info.texi This manual tells you how to use 82 Info. This document comes as part of 83 GNU Emacs. If you do not have Emacs, 84 you can format this Texinfo source 85 file with makeinfo or TeX and then 86 read the resulting Info file with the 87 standalone Info reader that is part of 88 this distribution. 89 90 info-stnd.texi This manual tells you how to use 91 the standalone GNU Info reader that is 92 included in this distribution as C 93 source (./info). 94 95Printing related files: 96 97 doc/texinfo.tex This TeX definitions file tells 98 the TeX program how to typeset a 99 Texinfo file into a DVI file ready for 100 printing. 101 102 util/texindex.c This file contains the source for 103 the `texindex' program that generates 104 sorted indices used by TeX when 105 typesetting a file for printing. 106 107 util/texi2dvi This is a shell script for 108 producing an indexed DVI file using 109 TeX and texindex. 110 111 112Source files for standalone C programs (./lib, ./makeinfo, ./info): 113 114 makeinfo/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/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 123Installation files: 124 125 configure This file creates creates a Makefile 126 which in turn creates an `info' or 127 `makeinfo' executable, or a C sources 128 distribution. 129 130 configure.in This is a template for creating 131 `configure' using Autoconf. 132 133 Makefile.in This is a template for `configure' 134 to use to make a Makefile. Created by 135 Automake. 136 137 Makefile.am This is a template for Automake 138 to use to make a Makefile.in. 139 140 141Other files: 142 143 fixfonts This is a shell script to install the 144 `lcircle10' TeX fonts as an alias for 145 the `circle10' fonts. In some older 146 TeX distributions the names are 147 different. 148 149 tex3patch This handles a bug for version 150 3.0 of TeX that does not occur in 151 more recent versions. 152