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