diff options
Diffstat (limited to 'gnu/usr.bin/texinfo/README')
| -rw-r--r-- | gnu/usr.bin/texinfo/README | 81 |
1 files changed, 24 insertions, 57 deletions
diff --git a/gnu/usr.bin/texinfo/README b/gnu/usr.bin/texinfo/README index 0312f85e6f6..15f83239d42 100644 --- a/gnu/usr.bin/texinfo/README +++ b/gnu/usr.bin/texinfo/README @@ -1,62 +1,48 @@ This is the README file for the GNU Texinfo distribution. +The primary distribution point is ftp://ftp.gnu.org/pub/gnu. -Please email bugs or suggestions to bug-texinfo@prep.ai.mit.edu. +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. -Files within this distribution have their own version and edition -numbers. When you refer to a file, please mention its own version, as -well as the version number of the Texinfo distribution. +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 instructions on compiling and installing info, makeinfo, texi2dvi, -and texindex, please read the file `INSTALL'. Also: - - * The Emacs Lisp files are not compiled or installed by default; to - install them, use `make install' in the `emacs' subdirectory. See - ./emacs/README for some considerations. +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 or not as you like. + 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, it might contain the command @afourpaper. See the `Preparing for TeX' node in texinfo.texi for more details. - -Texinfo is a documentation system that uses a single source file to -produce both online information and printed output. This means that -instead of writing two different documents, one for the online help or -other online information and the other for a typeset manual or other -printed work, you need write only one document. When the work is -revised, you need revise only one document. You can read the online -information, known as an "Info file", with an Info documentation-reading -program. By convention, Texinfo source file names end with a `.texi' or -`.texinfo' extension. Texinfo is described in the Texinfo manual (the -file ./doc/texinfo.texi). - -You can write and format Texinfo files into Info files within GNU Emacs, -and read them using the Emacs Info reader. If you do not have Emacs, -you can format Texinfo files into Info files using `makeinfo' and read -them using `info'. Use TeX, which is not included in this package (see -`How to Obtain TeX' in the Texinfo manual for information), to typeset -Texinfo files for printing. + * 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. This distribution includes (but is not limited to) the following files: README This file. - INTRODUCTION This file tells you how to create - readable files from the Texinfo source - files in this distribution. + 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 Texinfo. It + 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, how to use TeX, - makeinfo, and the Emacs Lisp Texinfo - formatting commands. + 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 @@ -74,7 +60,7 @@ Texinfo source files (in ./doc): Printing related files: - texinfo.tex This TeX definitions file tells + doc/texinfo.tex This TeX definitions file tells the TeX program how to typeset a Texinfo file into a DVI file ready for printing. @@ -90,25 +76,6 @@ Printing related files: source document uses Texinfo @macros. -GNU Emacs related files (in ./emacs): - - texinfmt.el This Emacs Lisp file provides the - functions that GNU Emacs uses to - format a Texinfo file into an Info - file. - - texinfo.el This file provides Texinfo mode - for GNU Emacs. - - texnfo-upd.el These files provides commands to - makeinfo.el help you write Texinfo files - using GNU Emacs Texinfo mode. - - info.el These are the standard GNU Emacs - informat.el Info reading and support files, - included here for your convenience. - - Source files for standalone C programs (./lib, ./makeinfo, ./info): makeinfo.c This file contains the source for @@ -143,7 +110,7 @@ Installation files: to use to make a Makefile.in. -Other files: +Other files (util): NEWS This contains a summary of new features since the first edition |