README revision 114472 
1$Id: README,v 1.14 2003/01/03 20:17:37 karl Exp $
2This is the README file for the GNU Texinfo distribution.
3
4  Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
5  2001, 2002, 2003 Free Software Foundation, Inc.
6
7  Copying and distribution of this file, with or without modification,
8  are permitted in any medium without royalty provided the copyright
9  notice and this notice are preserved.
10
11See ./INSTALL* for installation instructions.
12
13Primary distribution point: ftp://ftp.gnu.org/gnu/texinfo/
14  (list of mirrors at: http://www.gnu.org/prep/ftp.html)
15
16Home page: http://www.gnu.org/software/texinfo/
17  (list of mirrors at: http://www.gnu.org/server/list-mirrors.html)
18  This page includes links to other Texinfo-related programs.
19
20Mailing lists and archives:
21- bug-texinfo@gnu.org for bug reports or enhancement suggestions,
22  archive: http://mail.gnu.org/pipermail/bug-texinfo
23- help-texinfo@gnu.org for authoring questions and general discussion, 
24  archive: http://mail.gnu.org/pipermail/help-texinfo
25- texinfo-pretest@texinfo.org for pretests of new releases,
26  archive: http://texinfo.org/ftp/texinfo-pretest-archive
27There are no corresponding newsgroups.
28
29Bug reports:
30 please include enough information for the maintainers to reproduce the
31 problem.  Generally speaking, that means:
32- the contents of any input files necessary to reproduce the bug (crucial!).
33- a description of the problem and any samples of the erroneous output.
34- the version number of Texinfo and the program(s) involved (use --version).
35- hardware, operating system, and compiler versions (uname -a).
36- unusual options you gave to configure, if any (see config.status).
37- anything else that you think would be helpful.
38
39Patches are most welcome; if possible, please make them with diff -c and
40include ChangeLog entries.
41
42When sending email, please do not encode or split the messages in any
43way if at all possible; it's easier to deal with one large message than
44many small ones.  GNU shar (http://www.gnu.org/software/sharutils/) is a
45convenient way of packaging multiple and/or binary files for email.
46
47See README.dev for information on the Texinfo development environment --
48any interested parties are welcome.  If you're a programmer and wish to
49contribute, this should get you started.  And if you're not a
50programmer, you can still make significant contributions by writing test
51cases, checking the documentation against the implementation, etc.
52
53This distribution includes the following files, among others:
54    README                      This file.
55    README.dev                  Texinfo developer information.
56
57    INSTALL                     Texinfo-specific installation notes.
58    NEWS                        Summary of new features by release.
59    INTRODUCTION                Brief introduction to the system, and
60                                how to create readable files from the
61                                Texinfo source files in this distribution.
62
63Texinfo documentation files (in ./doc):
64    texinfo.txi                 Describes the Texinfo language and many
65                                of the associated tools.  It tells how
66                                to use Texinfo to write documentation,
67                                how to use Texinfo mode in GNU Emacs,
68                                TeX, makeinfo, and the Emacs Lisp
69                                Texinfo formatting commands.
70
71    info.texi                   This manual tells you how to use 
72                                Info.  This document also comes as part of
73                                GNU Emacs.  If you do not have Emacs,
74                                you can format this Texinfo source
75                                file with makeinfo or TeX and then
76                                read the resulting Info file with the
77                                standalone Info reader that is part of
78                                this distribution.
79
80    info-stnd.texi              This manual tells you how to use
81                                the standalone GNU Info reader that is
82                                included in this distribution as C
83                                source (./info).
84
85Printing related files:
86    doc/texinfo.tex             This TeX definitions file tells
87                                the TeX program how to typeset a
88                                Texinfo file into a DVI file ready for
89                                printing.
90
91    util/texindex.c             This file contains the source for
92                                the `texindex' program that generates
93                                sorted indices used by TeX when
94                                typesetting a file for printing.
95
96    util/texi2dvi               This is a shell script for
97                                producing an indexed DVI file using
98                                TeX and texindex. 
99
100Source files for standalone C programs: 
101  ./lib
102  ./makeinfo
103  ./info
104
105Installation files:
106    Makefile.am                 What Automake uses to make a Makefile.in.
107    Makefile.in                 What `configure' uses to make a Makefile,
108                                created by Automake.
109    configure.ac		What Autoconf uses to create `configure'.
110    configure                   Configuration script for local conditions,
111                                created by Autoconf.
112