1
Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 99, 2000, 01, 02
2
Free Software Foundation.
4
Permission is granted to copy, distribute and/or modify this document
5
under the terms of the GNU Free Documentation License, Version 1.1 or
6
any later version published by the Free Software Foundation; with no
7
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts.
10
This is the README file for the GNU Texinfo distribution.
11
The primary distribution point is ftp://ftp.gnu.org/gnu/texinfo/
12
and the primary home page is http://www.gnu.org/software/texinfo/,
13
secondary home page at http://texinfo.org/.
1
$Id: README,v 1.16 2004/12/13 13:36:32 karl Exp $
2
This is the README file for the GNU Texinfo distribution. Texinfo is
3
the preferred documentation format for GNU software.
5
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
6
2001, 2002, 2003, 2004 Free Software Foundation, Inc.
8
Copying and distribution of this file, with or without modification,
9
are permitted in any medium without royalty provided the copyright
10
notice and this notice are preserved.
12
See ./INSTALL* for installation instructions.
14
Primary distribution point: ftp://ftp.gnu.org/gnu/texinfo/
15
(list of mirrors at: http://www.gnu.org/prep/ftp.html)
17
Home page: http://www.gnu.org/software/texinfo/
18
(list of mirrors at: http://www.gnu.org/server/list-mirrors.html)
19
This page includes links to other Texinfo-related programs.
21
Mailing lists and archives:
16
22
- 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/.
23
archive: http://mail.gnu.org/pipermail/bug-texinfo
24
- help-texinfo@gnu.org for authoring questions and general discussion,
25
archive: http://mail.gnu.org/pipermail/help-texinfo
20
26
- texinfo-pretest@texinfo.org for pretests of new releases,
21
archived at ftp://ftp.texinfo.org/texinfo/texinfo-pretest-archive/.
22
There are as yet no corresponding newsgroups.
27
archive: http://texinfo.org/ftp/texinfo-pretest-archive
28
There are no corresponding newsgroups.
24
For bug reports, please include enough information for the maintainers
25
to reproduce the problem. Generally speaking, that means:
31
please include enough information for the maintainers to reproduce the
32
problem. Generally speaking, that means:
26
33
- the contents of any input files necessary to reproduce the bug (crucial!).
27
34
- a description of the problem and any samples of the erroneous output.
28
35
- the version number of Texinfo and the program(s) involved (use --version).
29
36
- hardware, operating system, and compiler versions (uname -a).
30
- any unusual options you gave to configure (see config.status).
37
- unusual options you gave to configure, if any (see config.status).
31
38
- anything else that you think would be helpful.
33
40
Patches are most welcome; if possible, please make them with diff -c and
36
43
When sending email, please do not encode or split the messages in any
37
44
way if at all possible; it's easier to deal with one large message than
38
many small ones. GNU shar is a convenient way of packaging multiple
39
and/or binary files for email.
42
For generic installation instructions on compiling and installing this
43
Automake-based distribution, please read the file `INSTALL'.
44
Installation notes specific to Texinfo:
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.
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.
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.
60
* For instructions on compiling this distribution with DJGPP tools
61
for MS-DOS and MS-Windows, see the file djgpp/README.
64
If you would like to contribute to the GNU project by implementing
65
additional documentation output formats for Texinfo, that would be
66
great. But please do not write a separate translator texi2foo for your
67
favorite format foo! That is the hard way to do the job, and makes
68
extra work in subsequent maintenance, since the Texinfo language is
69
continually being enhanced and updated. Instead, the best approach is
70
modify Makeinfo to generate the new format, as it does now for Info,
71
HTML, XML, and DocBook.
73
If you want to convert from DocBook to Texinfo, please see
74
http://docbook2X.sourceforge.net/.
45
many small ones. GNU shar (http://www.gnu.org/software/sharutils/) is a
46
convenient way of packaging multiple and/or binary files for email.
48
See README.dev for information on the Texinfo development environment --
49
any interested parties are welcome. If you're a programmer and wish to
50
contribute, this should get you started. And if you're not a
51
programmer, you can still make significant contributions by writing test
52
cases, checking the documentation against the implementation, etc.
77
54
This distribution includes the following files, among others:
56
README.dev Texinfo developer information.
58
INSTALL Texinfo-specific installation notes.
80
59
NEWS Summary of new features by release.
82
60
INTRODUCTION Brief introduction to the system, and
83
61
how to create readable files from the
84
62
Texinfo source files in this distribution.
86
Texinfo source files (in ./doc):
64
Texinfo documentation files (in ./doc):
87
65
texinfo.txi Describes the Texinfo language and many
88
66
of the associated tools. It tells how
89
67
to use Texinfo to write documentation,
120
98
producing an indexed DVI file using
124
Source files for standalone C programs (./lib, ./makeinfo, ./info):
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
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.
101
Source files for standalone C programs:
135
106
Installation files:
136
configure This file creates creates a Makefile
137
which in turn creates an `info' or
138
`makeinfo' executable, or a C sources
141
configure.in This is a template for creating
142
`configure' using Autoconf.
144
Makefile.in This is a template for `configure'
145
to use to make a Makefile. Created by
148
Makefile.am This is a template for Automake
149
to use to make a Makefile.in.
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
159
tex3patch This handles a bug for version
160
3.0 of TeX that does not occur in
161
more recent versions.
107
Makefile.am What Automake uses to make a Makefile.in.
108
Makefile.in What `configure' uses to make a Makefile,
110
configure.ac What Autoconf uses to create `configure'.
111
configure Configuration script for local conditions,
added
removed
README
