From 05f7b4b96773cc26ff78d5e68babd66861aa07a8 Mon Sep 17 00:00:00 2001 From: ru Date: Mon, 17 Jan 2000 10:39:58 +0000 Subject: Virgin import of GNU texinfo 4.0 --- contrib/texinfo/README | 104 ++++++++++++++++++++++++++++++------------------- 1 file changed, 64 insertions(+), 40 deletions(-) (limited to 'contrib/texinfo/README') diff --git a/contrib/texinfo/README b/contrib/texinfo/README index 15f8323..0b865ef 100644 --- a/contrib/texinfo/README +++ b/contrib/texinfo/README @@ -1,48 +1,82 @@ This is the README file for the GNU Texinfo distribution. -The primary distribution point is ftp://ftp.gnu.org/pub/gnu. +The primary distribution point is ftp://ftp.gnu.org/gnu/texinfo/. + +Mailing lists: +- bug-texinfo@gnu.org for bug reports or enhancement suggestions, + archived at ftp://ftp-mailing-list-archives.gnu.org/. +- help-texinfo@gnu.org for authoring questions and general discussion. + archived at the same place. +- texinfo-pretest@tug.org for pretests of new releases, + archived at http://tug.org/archives/texinfo-pretest/. +There are as yet no corresponding newsgroups. + +For bug reports, please include enough information for the maintainers +to reproduce the problem. Generally speaking, that means: +- the version number of Texinfo and the program(s) involved (use --version). +- hardware, operating system, and compiler versions (uname -a). +- any unusual options you gave to configure (see config.status). +- the contents of any input files necessary to reproduce the bug (crucial!). +- a description of the problem and any samples of the erroneous output. +- 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 +way if at all possible; it's much easier to deal with one large message +than many small ones. GNU shar is a convenient way of packaging +multiple and/or binary files for email. -Please email bugs or suggestions to bug-texinfo@gnu.org. (If you wish, -you can join this list by sending a subscribe message to -bug-texinfo-request@gnu.org.) Patches are welcome; if possible, please -make them with diff -c and include ChangeLog entries. - -Programs within this distribution have their own version numbers. When -you refer to a file, please mention its own version, as well as the -version number of the Texinfo distribution. For generic installation instructions on compiling and installing this Automake-based distribution, please read the file `INSTALL'. Installation notes specific to Texinfo: - * The Info tree uses a file `dir' as its root node; the `dir-example' - file in this distribution is included for informative purposes. - Use it, modify it, or ignore it just as you like. +* The Info tree uses a file `dir' as its root node; the `dir-example' + file in this distribution is included as a possible starting point. + Use it, modify it, or ignore it just as you like. + +* You can create a file texinfo.cnf to be read by TeX when + processing Texinfo manuals. For example, you might like to use + @afourpaper by default. See the `Preparing for TeX' node in + texinfo.txi for more details. You don't have to create the file if + you have nothing to put in it. + +* If your info files are not in $prefix/info, you may wish to add a line +#define DEFAULT_INFOPATH "/mydir1:/mydir2:..." + to config.h after running configure. - * You can create a file texinfo.cnf to be read by TeX when - processing Texinfo manuals. For example, it might contain the - command @afourpaper. See the `Preparing for TeX' node in - texinfo.texi for more details. +* For instructions on compiling this distribution with DJGPP tools + for MS-DOS and MS-Windows, please see the file djgpp/README. - * If your info files are not in $prefix/info, you may wish to add a line -#define DEFAULT_INFOPATH "/mydir1:/mydir2:/etc" - to config.h after running configure. +If you would like to contribute to the GNU project by implementing +additional documentation output formats for Texinfo, that would be +great. But please do not write a separate translator texi2foo for your +favorite format foo! That is the hard way to do the job, and makes +extra work in subsequent maintenance, since the Texinfo language is +continually being enhanced and updated. Instead, the best approach is +modify Makeinfo to generate the new format, as it does now for Info and HTML. -This distribution includes (but is not limited to) the following files: + +This distribution includes the following files, among others: README This file. + + NEWS Summary of new features by release. + INTRODUCTION Brief introduction to the system, and how to create readable files from the Texinfo source files in this distribution. Texinfo source files (in ./doc): - texinfo.texi This manual 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. + 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. info.texi This manual tells you how to use Info. This document comes as part of @@ -72,26 +106,20 @@ Printing related files: util/texi2dvi This is a shell script for producing an indexed DVI file using - TeX and texindex. Must be used if the - source document uses Texinfo @macros. + TeX and texindex. Source files for standalone C programs (./lib, ./makeinfo, ./info): - makeinfo.c This file contains the source for + makeinfo/makeinfo.c This file contains the source for the `makeinfo' program that you can use to create an Info file from a Texinfo file. - info.c This file contains the source for + info/info.c This file contains the source for the `info' program that you can use to view Info files on an ASCII terminal. - getopt.c Various support files - getopt1.c - getopt.h - - Installation files: configure This file creates creates a Makefile @@ -110,11 +138,7 @@ Installation files: to use to make a Makefile.in. -Other files (util): - - NEWS This contains a summary of new - features since the first edition - of Texinfo. +Other files: fixfonts This is a shell script to install the `lcircle10' TeX fonts as an alias for -- cgit v1.1