diff options
Diffstat (limited to 'gnu/usr.bin/texinfo/README')
| -rw-r--r-- | gnu/usr.bin/texinfo/README | 143 |
1 files changed, 47 insertions, 96 deletions
diff --git a/gnu/usr.bin/texinfo/README b/gnu/usr.bin/texinfo/README index 84854944a9d..55cc52998c0 100644 --- a/gnu/usr.bin/texinfo/README +++ b/gnu/usr.bin/texinfo/README @@ -1,33 +1,40 @@ -Copyright (C) 1992, 93, 94, 95, 96, 97, 98, 99, 2000, 01, 02 -Free Software Foundation, Inc. +$Id: README,v 1.1.1.7 2006/07/17 16:03:10 espie Exp $ +This is the README file for the GNU Texinfo distribution. Texinfo is +the preferred documentation format for GNU software. -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. + Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, + 2001, 2002, 2003, 2004 Free Software Foundation, Inc. + 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. -This is the README file for the GNU Texinfo distribution. -The primary distribution point is ftp://ftp.gnu.org/gnu/texinfo/ -and the primary home page is http://www.gnu.org/software/texinfo/, -secondary home page at http://texinfo.org/. +See ./INSTALL* for installation instructions. -Mailing lists: +Primary distribution point: ftp://ftp.gnu.org/gnu/texinfo/ + (list of mirrors at: http://www.gnu.org/prep/ftp.html) + +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: - bug-texinfo@gnu.org for bug reports or enhancement suggestions, - archived at ftp://ftp-mailing-list-archives.gnu.org/bug-texinfo/. -- help-texinfo@gnu.org for authoring questions and general discussion. - archived at ftp://ftp-mailing-list-archives.gnu.org/help-texinfo/. + 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 - texinfo-pretest@texinfo.org for pretests of new releases, - archived at ftp://ftp.texinfo.org/texinfo/texinfo-pretest-archive/. -There are as yet no corresponding newsgroups. + archive: http://texinfo.org/ftp/texinfo-pretest-archive +There are no corresponding newsgroups. -For bug reports, please include enough information for the maintainers -to reproduce the problem. Generally speaking, that means: +Bug reports: + please include enough information for the maintainers to reproduce the + problem. Generally speaking, that means: - the contents of any input files necessary to reproduce the bug (crucial!). - a description of the problem and any samples of the erroneous output. - 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). +- unusual options you gave to configure, if any (see config.status). - anything else that you think would be helpful. Patches are most welcome; if possible, please make them with diff -c and @@ -35,55 +42,26 @@ include ChangeLog entries. When sending email, please do not encode or split the messages in any way if at all possible; it's 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. - - -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 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. - -* For instructions on compiling this distribution with DJGPP tools - for MS-DOS and MS-Windows, see the file djgpp/README. - - -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, -HTML, XML, and DocBook. - -If you want to convert from DocBook to Texinfo, please see -http://docbook2X.sourceforge.net/. +many small ones. GNU shar (http://www.gnu.org/software/sharutils/) is a +convenient way of packaging multiple and/or binary files for email. +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. This distribution includes the following files, among others: README This file. + README.dev Texinfo developer information. + INSTALL Texinfo-specific installation notes. 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 documentation files (in ./doc): texinfo.txi Describes the Texinfo language and many of the associated tools. It tells how to use Texinfo to write documentation, @@ -92,7 +70,7 @@ Texinfo source files (in ./doc): Texinfo formatting commands. info.texi This manual tells you how to use - Info. This document comes as part of + Info. This document also comes as part of GNU Emacs. If you do not have Emacs, you can format this Texinfo source file with makeinfo or TeX and then @@ -120,42 +98,15 @@ Printing related files: producing an indexed DVI file using TeX and texindex. - -Source files for standalone C programs (./lib, ./makeinfo, ./info): - - 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/info.c This file contains the source for - the `info' program that you can use to - view Info files on an ASCII terminal. +Source files for standalone C programs: + ./lib + ./makeinfo + ./info Installation files: - configure This file creates creates a Makefile - which in turn creates an `info' or - `makeinfo' executable, or a C sources - distribution. - - configure.in This is a template for creating - `configure' using Autoconf. - - Makefile.in This is a template for `configure' - to use to make a Makefile. Created by - Automake. - - Makefile.am This is a template for Automake - to use to make a Makefile.in. - - -Other files: - fixfonts This is a shell script to install the - `lcircle10' TeX fonts as an alias for - the `circle10' fonts. In some older - TeX distributions the names are - different. - - tex3patch This handles a bug for version - 3.0 of TeX that does not occur in - more recent versions. + 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. |