2005-05-23 10:46:22 +00:00
|
|
|
$Id: README,v 1.16 2004/12/13 13:36:32 karl Exp $
|
|
|
|
|
This is the README file for the GNU Texinfo distribution. Texinfo is
|
|
|
|
|
the preferred documentation format for GNU software.
|
2002-03-25 13:08:32 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
|
2005-05-23 10:46:22 +00:00
|
|
|
2001, 2002, 2003, 2004 Free Software Foundation, Inc.
|
2002-03-25 13:08:32 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Copying and distribution of this file, with or without modification,
|
|
|
|
|
are permitted in any medium without royalty provided the copyright
|
|
|
|
|
notice and this notice are preserved.
|
2002-03-25 13:08:32 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
See ./INSTALL* for installation instructions.
|
|
|
|
|
|
|
|
|
|
Primary distribution point: ftp://ftp.gnu.org/gnu/texinfo/
|
|
|
|
|
(list of mirrors at: http://www.gnu.org/prep/ftp.html)
|
2000-01-17 10:39:58 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Home page: http://www.gnu.org/software/texinfo/
|
|
|
|
|
(list of mirrors at: http://www.gnu.org/server/list-mirrors.html)
|
|
|
|
|
This page includes links to other Texinfo-related programs.
|
|
|
|
|
|
|
|
|
|
Mailing lists and archives:
|
2000-01-17 10:39:58 +00:00
|
|
|
- bug-texinfo@gnu.org for bug reports or enhancement suggestions,
|
2003-05-02 00:48:41 +00:00
|
|
|
archive: http://mail.gnu.org/pipermail/bug-texinfo
|
|
|
|
|
- help-texinfo@gnu.org for authoring questions and general discussion,
|
|
|
|
|
archive: http://mail.gnu.org/pipermail/help-texinfo
|
2002-03-25 13:08:32 +00:00
|
|
|
- texinfo-pretest@texinfo.org for pretests of new releases,
|
2003-05-02 00:48:41 +00:00
|
|
|
archive: http://texinfo.org/ftp/texinfo-pretest-archive
|
|
|
|
|
There are no corresponding newsgroups.
|
2000-01-17 10:39:58 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Bug reports:
|
|
|
|
|
please include enough information for the maintainers to reproduce the
|
|
|
|
|
problem. Generally speaking, that means:
|
2002-03-25 13:08:32 +00:00
|
|
|
- the contents of any input files necessary to reproduce the bug (crucial!).
|
|
|
|
|
- a description of the problem and any samples of the erroneous output.
|
2000-01-17 10:39:58 +00:00
|
|
|
- the version number of Texinfo and the program(s) involved (use --version).
|
|
|
|
|
- hardware, operating system, and compiler versions (uname -a).
|
2003-05-02 00:48:41 +00:00
|
|
|
- unusual options you gave to configure, if any (see config.status).
|
2000-01-17 10:39:58 +00:00
|
|
|
- anything else that you think would be helpful.
|
|
|
|
|
|
|
|
|
|
Patches are most welcome; if possible, please make them with diff -c and
|
|
|
|
|
include ChangeLog entries.
|
|
|
|
|
|
|
|
|
|
When sending email, please do not encode or split the messages in any
|
2002-03-25 13:08:32 +00:00
|
|
|
way if at all possible; it's easier to deal with one large message than
|
2003-05-02 00:48:41 +00:00
|
|
|
many small ones. GNU shar (http://www.gnu.org/software/sharutils/) is a
|
|
|
|
|
convenient way of packaging multiple and/or binary files for email.
|
2000-01-17 10:39:58 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
See README.dev for information on the Texinfo development environment --
|
|
|
|
|
any interested parties are welcome. If you're a programmer and wish to
|
|
|
|
|
contribute, this should get you started. And if you're not a
|
|
|
|
|
programmer, you can still make significant contributions by writing test
|
|
|
|
|
cases, checking the documentation against the implementation, etc.
|
1997-01-11 02:12:38 +00:00
|
|
|
|
2002-03-25 13:08:32 +00:00
|
|
|
This distribution includes the following files, among others:
|
1997-01-11 02:12:38 +00:00
|
|
|
README This file.
|
2003-05-02 00:48:41 +00:00
|
|
|
README.dev Texinfo developer information.
|
2000-01-17 10:39:58 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
INSTALL Texinfo-specific installation notes.
|
2000-01-17 10:39:58 +00:00
|
|
|
NEWS Summary of new features by release.
|
1999-01-14 19:35:19 +00:00
|
|
|
INTRODUCTION Brief introduction to the system, and
|
|
|
|
|
how to create readable files from the
|
|
|
|
|
Texinfo source files in this distribution.
|
1997-01-11 02:12:38 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Texinfo documentation files (in ./doc):
|
2000-01-17 10:39:58 +00:00
|
|
|
texinfo.txi Describes the Texinfo language and many
|
|
|
|
|
of the associated tools. It tells how
|
|
|
|
|
to use Texinfo to write documentation,
|
|
|
|
|
how to use Texinfo mode in GNU Emacs,
|
|
|
|
|
TeX, makeinfo, and the Emacs Lisp
|
|
|
|
|
Texinfo formatting commands.
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
info.texi This manual tells you how to use
|
2003-05-02 00:48:41 +00:00
|
|
|
Info. This document also comes as part of
|
1997-01-11 02:12:38 +00:00
|
|
|
GNU Emacs. If you do not have Emacs,
|
|
|
|
|
you can format this Texinfo source
|
|
|
|
|
file with makeinfo or TeX and then
|
|
|
|
|
read the resulting Info file with the
|
|
|
|
|
standalone Info reader that is part of
|
|
|
|
|
this distribution.
|
|
|
|
|
|
|
|
|
|
info-stnd.texi This manual tells you how to use
|
|
|
|
|
the standalone GNU Info reader that is
|
1999-01-14 19:35:19 +00:00
|
|
|
included in this distribution as C
|
|
|
|
|
source (./info).
|
1997-01-11 02:12:38 +00:00
|
|
|
|
|
|
|
|
Printing related files:
|
1999-01-14 19:35:19 +00:00
|
|
|
doc/texinfo.tex This TeX definitions file tells
|
1997-01-11 02:12:38 +00:00
|
|
|
the TeX program how to typeset a
|
|
|
|
|
Texinfo file into a DVI file ready for
|
|
|
|
|
printing.
|
|
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
util/texindex.c This file contains the source for
|
1997-01-11 02:12:38 +00:00
|
|
|
the `texindex' program that generates
|
|
|
|
|
sorted indices used by TeX when
|
|
|
|
|
typesetting a file for printing.
|
|
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
util/texi2dvi This is a shell script for
|
1997-01-11 02:12:38 +00:00
|
|
|
producing an indexed DVI file using
|
2000-01-17 10:39:58 +00:00
|
|
|
TeX and texindex.
|
1997-01-11 02:12:38 +00:00
|
|
|
|
2003-05-02 00:48:41 +00:00
|
|
|
Source files for standalone C programs:
|
|
|
|
|
./lib
|
|
|
|
|
./makeinfo
|
|
|
|
|
./info
|
1997-01-11 02:12:38 +00:00
|
|
|
|
1999-01-14 19:35:19 +00:00
|
|
|
Installation files:
|
2003-05-02 00:48:41 +00:00
|
|
|
Makefile.am What Automake uses to make a Makefile.in.
|
|
|
|
|
Makefile.in What `configure' uses to make a Makefile,
|
|
|
|
|
created by Automake.
|
|
|
|
|
configure.ac What Autoconf uses to create `configure'.
|
|
|
|
|
configure Configuration script for local conditions,
|
|
|
|
|
created by Autoconf.
|
