ccaa2ac97b
Changes since 4.6:
4.7 (9 April 2004)
* Language:
. new commands @float, @caption, @shortcaption, @listoffloats for
initial implementation of floating material (figures, tables, etc).
Ironically, they do not yet actually float anywhere.
. new commands @docbook, @ifdocbook, @ifnotdocbook for conditional Docbook.
. new commands @ordf{} and @ordm{} for Spanish feminine/masculine ordinals.
. new commands @deftypecv[x] for class variables in typed OO languages.
. new command @registeredsymbol for the r-in-a-circle symbol.
. new command @headitem to make a heading row in @multitable.
. new command @LaTeX{} for the LaTeX logo.
. new command @comma{} to avoid comma-parsing problems.
. @url is now a synonym for @uref; new command @indicateurl has the
old meaning of just displaying a url as text.
. @quotation now accepts an optional argument for labelling the text
as a `Note', `Tip', etc.
. @defun (et al.) heading lines can now be continued with a lone @.
. @acronym accepts an optional argument for the meaning of the acronym.
* makeinfo:
. New environment variable TEXINFO_OUTPUT_FORMAT determines the output
format at runtime, if no options are specified.
. New option --plaintext, equivalent to --no-headers with Info output.
. All outputs:
- sections are numbered by default.
. Info output:
- punctuation is inserted after @pxref and @ref, if needed to make
cross-references valid.
- line numbers included in index menus, so Info readers can go to
the exact line of an entry, not just a node. Also in plaintext output.
- ^@^H[index^@^H] cookie included in index menus, so Info readers
can handle the ] etc. commands better.
. HTML output:
- new algorithm for cross-references to other manuals, for maximum
portability and stability.
- include node name in <title> with split output.
- @multicolumn fractions become percentages.
- entities used for bullets, quotes, dashes, and others.
- index entries are links to the exact locations.
- <h4> and <h5> used for @sub and @subsubsections again.
- accented dotless i supported.
. XML output: many new tags and structure to preserve more source features.
. Docbook output:
- upgraded DTD to Docbook XML 4.2, no longer using Docbook SGML.
- improved translation in general, for instance:
- line annotations and marked quotations.
* texi2dvi:
. if available, use etex (pdfetex if --pdf) by default.
. if the input file includes thumbpdf.sty (for LaTeX), then run thumbpdf.
. more output if --debug.
* texinfo.tex:
. @defun names are now printed in typewriter (instead of bold), and
within the arguments, @var text is printed in slanted typewriter.
. @tex code is executed inside a TeX group, so that any changes must
be prefixed with \global (or the equivalent) to be effective. (This
change was actually made years ago, but never made it into the NEWS.)
* info:
. new option --where (aka --location, -w) to report where an Info file
would be found, instead of reading it.
. by default, output ANSI terminal escape sequences as-is; new option
--no-raw-escapes overrides this.
. use the newly-generated index line numbers.
* Distribution:
. new script gendocs.sh (not installed), for use by GNU maintainers in
getting their manuals on the GNU web site. Documented in
maintain.texi (http://www.gnu.org/prep/maintain_toc.html).
. Most code uses ANSI C prototypes, to some extent.
. New translation: nb.
. automake 1.8.3, autoconf 2.59, gettext 0.14.1.
109 lines
3.8 KiB
Plaintext
109 lines
3.8 KiB
Plaintext
Id: INTRODUCTION,v 1.1.1.1 2003/12/06 01:30:34 karl Exp
|
|
Getting started with Texinfo.
|
|
|
|
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
|
|
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.
|
|
|
|
|
|
|
|
Getting Started with Texinfo
|
|
============================
|
|
|
|
"Texinfo" is a documentation system that uses a single source file to
|
|
produce both on-line information and printed output. Using Texinfo,
|
|
you can create a printed document with the normal features of a book,
|
|
including chapters, sections, cross references, and indices. From the
|
|
same Texinfo source file, you can create a menu-driven, on-line Info
|
|
file with nodes, menus, cross references, and indices.
|
|
|
|
The name of the Texinfo source documentation file is `texinfo.txi'.
|
|
You can produce both on-line information and printed output from this
|
|
source file. The documentation describes Texinfo in detail, including
|
|
how to write Texinfo files, how to format them for both hard copy and
|
|
Info, and how to install Info files.
|
|
|
|
To get started, you need to create either a printed manual or an
|
|
on-line Info file from the `texinfo.txi' file. You do not need to
|
|
create both, although you will probably want both eventually.
|
|
|
|
To learn how to use Info, read the info documentation. You can do this in
|
|
one of two ways: using the standalone `info' program, or using Info mode in
|
|
GNU Emacs.
|
|
|
|
* If you want to use the `info' program, run
|
|
|
|
info -f info-stnd
|
|
|
|
* If you want to use Emacs, start up emacs and type `C-h i' [M-x info].
|
|
Follow the instructions to learn how to use Info.
|
|
|
|
After learning how to use Info, you can read the Texinfo documentation.
|
|
Using the standalone `info', type the following at the shell prompt:
|
|
|
|
info -f texinfo
|
|
|
|
To use read this manual in Emacs, you first need to edit the Info-directory
|
|
menu (the file `dir' in the system info directory) to contain the
|
|
appropriate node. To learn how to do this, see node: Add in the Info
|
|
documentation.
|
|
|
|
The Texinfo documentation describes Texinfo in detail; among other things,
|
|
it tells how to install Info files in the usual manner. (See node: Install
|
|
an Info File.)
|
|
|
|
The `info-stnd.info' file describes the standalone Info reader in detail. To
|
|
read this file, type
|
|
|
|
$ info -f info-stnd
|
|
|
|
|
|
To create a printed manual
|
|
==========================
|
|
|
|
You need:
|
|
|
|
* The `tex' program, which typesets the manual using TeX.
|
|
* The `texinfo.tex' definition file that tells TeX how to typeset
|
|
a Texinfo file.
|
|
* The `texindex' program, which sorts the unsorted index files
|
|
created by TeX.
|
|
* A printing program such as `lp' or `lpr',
|
|
* A printer.
|
|
|
|
This Texinfo distribution package contains `texinfo.tex', the C source
|
|
for `texindex', and the handy shell script `texi2dvi'. The `tex'
|
|
program is not part of this distribution, but is available separately.
|
|
(See `How to Obtain TeX' in the Texinfo documentation.)
|
|
|
|
* Install `tex'. (`texindex' is installed automagically by
|
|
`make install' in this distribution.)
|
|
|
|
* Move the `texinfo.tex' file to an appropriate directory; the current
|
|
directory will do. (`/usr/local/lib/tex/inputs' might be a good place.
|
|
See ``Preparing to Use TeX'' in the Texinfo manual, for more
|
|
information.)
|
|
|
|
After following those instructions, type the following to make the .dvi
|
|
files:
|
|
|
|
$ (cd doc; make dvi)
|
|
|
|
You can then print the resulting .dvi files with the `lpr' or `lp'
|
|
commands, or maybe `dvips'.
|
|
|
|
For example, the command to print the texinfo.dvi file might be:
|
|
|
|
$ lpr -d texinfo.dvi
|
|
|
|
The name of the printing command depends on the system; `lpr -d' is
|
|
common, and is illustrated here. You may use a different name for the
|
|
printing command.
|
|
|
|
Please report bugs to bug-texinfo@gnu.org.
|
|
|
|
Happy formatting.
|