summaryrefslogtreecommitdiffstats
path: root/contrib/texinfo/README
diff options
context:
space:
mode:
authormarkm <markm@FreeBSD.org>1999-01-14 19:35:19 +0000
committermarkm <markm@FreeBSD.org>1999-01-14 19:35:19 +0000
commit15da023077f02380356169c9b5f4a62a6dc51f63 (patch)
tree570e5cf5730d6009252842b5ff3e1405c775afa0 /contrib/texinfo/README
parente1e3a1dbda026c65b84c4017dd6194d619f89115 (diff)
downloadFreeBSD-src-15da023077f02380356169c9b5f4a62a6dc51f63.zip
FreeBSD-src-15da023077f02380356169c9b5f4a62a6dc51f63.tar.gz
Upgrade texinfo to the latest-and-greatest.
This has big improvements to the .info file utility support and much recent OSS requires its features.
Diffstat (limited to 'contrib/texinfo/README')
-rw-r--r--contrib/texinfo/README138
1 files changed, 51 insertions, 87 deletions
diff --git a/contrib/texinfo/README b/contrib/texinfo/README
index 357a98f..15f8323 100644
--- a/contrib/texinfo/README
+++ b/contrib/texinfo/README
@@ -1,54 +1,48 @@
-Texinfo, Version 3
-==================
-
-This is the README file for version 3 of the Texinfo distribution.
-Files within this distribution have their own version and edition
-numbers. When you refer to a file, please mention its own number, as
-well as the version number of the Texinfo distribution.
-
-PLEASE REPORT BUGS TO: bug-texinfo@prep.ai.mit.edu
-
-Texinfo is a documentation system that uses a single source file to
-produce both on-line information and printed output. This means that
-instead of writing two different documents, one for the on-line help
-or other on-line 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
-on-line 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 ./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.
-
-For instructions on compiling and installing info, makeinfo, texi2dvi,
-and texindex, please read the file `INSTALL'. The Emacs Lisp files are
-not installed by default; to install them, use `make install' in the
-`emacs' subdirectory. The Info tree uses a file `dir' as its root node;
-a sample `dir' file is included in the distribution, but not installed
-anywhere. Use it or not as you like.
+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@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.
+
+ * 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.
+
+ * 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 Brief introduction to the system, and
+ how to create readable files from the
+ Texinfo source files in this distribution.
- INTRODUCTION This file tells you how to create
- readable files from the Texinfo source
- files in this distribution.
+Texinfo source files (in ./doc):
-Texinfo source files:
-
- 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
@@ -61,58 +55,28 @@ Texinfo source files:
info-stnd.texi This manual tells you how to use
the standalone GNU Info reader that is
- included in this distribution as a C
- source file, `info.c'.
-
- makeinfo.texi This manual tells you how to use
- makeinfo. The same information is
- contained in a chapter of the Texinfo
- manual; it has been extracted here for
- your convenience.
-
+ included in this distribution as C
+ source (./info).
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.
- texindex.c This file contains the source for
+ util/texindex.c This file contains the source for
the `texindex' program that generates
sorted indices used by TeX when
typesetting a file for printing.
- texi2dvi This is a shell script for
+ 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.
-GNU Emacs related files:
-
- 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
- texnfo-tex.el help you write Texinfo files
- makeinfo.el using GNU Emacs Texinfo mode.
-
- detexinfo.el This extra utility file contains functions
- to remove Texinfo commands from a
- Texinfo source file.
-
- 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:
+Source files for standalone C programs (./lib, ./makeinfo, ./info):
makeinfo.c This file contains the source for
the `makeinfo' program that you can
@@ -128,7 +92,7 @@ Source files for standalone C programs:
getopt.h
-C Installation files:
+Installation files:
configure This file creates creates a Makefile
which in turn creates an `info' or
@@ -136,22 +100,22 @@ C Installation files:
distribution.
configure.in This is a template for creating
- `configure' using m4 macros.
+ `configure' using Autoconf.
Makefile.in This is a template for `configure'
- to use to make a Makefile.
+ 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:
+Other files (util):
NEWS This contains a summary of new
features since the first edition
of Texinfo.
- info.1 This is a `man' page that briefly
- describes the standalone `info'
- program.
-
fixfonts This is a shell script to install the
`lcircle10' TeX fonts as an alias for
the `circle10' fonts. In some older
OpenPOWER on IntegriCloud