    This is the README file for the texi2html distribution.
    The primary distribution point is
    http://savannah.nongnu.org/download/texi2html/

    Installation
    ============

    For generic installation instructions on compiling and installing this
    Automake-based distribution, please read the file `INSTALL'.
    Installation notes specific to Texi2html:
    * Installation is fairly simple, no compilers are required.
    * You need to have perl version 5.00405, or higher installed
      on your system to run 'texi2html'. To play nice with encodings you
      need the Encode and Unicode::Normalize modules. It is likely that an
      older perl 5 version also works if File::Spec is present.
    * To generate Makefile.in etc., run `./autogen.sh' or autoreconf

    Getting Started with texi2html
    ==============================

    'texi2html' converts texinfo documents to HTML.

    Texinfo is the official documentation format of the GNU project. It
    uses a single source file to produce both on-line information and
    printed output. For more details about texinfo, see
    http://www.texinfo.org.

    In contrast to the HTML produced by 'makeinfo --html' (the 'makeinfo'
    program is part of the Texinfo distribution), the HTML output of
    'texi2html' is highly configurable. Among others, with 'texi2html' you
    can customize your entire page layout (like headers, footers, style
    sheets, etc), split documents at various levels and use 'latex2html' to
    convert @tex sections.

    'texi2html' should reasonably convert all Texinfo 4.8 constructs. If
    not, please send a bug report to 'texi2html-bug@nongnu.org'.

    To create HTML of texinfo documents
    ===================================

    Make sure that you have 'texi2html' correctly installed on your
    system. The general synopsis of 'texi2html' is

        texi2html [options] texinfo-source-file

    Without any options, this will create the file <docname>.html where
    <docname> is the basename of your texinfo files.

    Run 'texi2html -h' for a short overview of the most important options,
    or have a look at the texi2html man page. For more in-depth information
    see the texi2html texinfo manual.

    Customizing texi2html
    =====================

    Initialisation options are read first from
    '/usr/local/etc/texi2html/Config' (the exact location being changeable with
    the '--sysconfdir=dir' option to the configure script), then from
    $HOME/.texi2html/Config, then any command-line options including -init-file
    options; with later settings overriding earlier ones.

    The default initialisation options are defined in the
    'texi2html.init' file contained in the Texi2html distribution (in
    fact, a sed script pastes this file into the beginning of the perl
    file generated by `./configure' from texi2html.pl and generates the
    actual 'texi2html' script this way.).

    To customize 'texi2html' it is best if you copy the appropriate
    sections from the 'texi2html.init' file into an appropriate local
    initialization file, make the necessary changes there, and then have
    'texi2html' read this initialisation file by one of the means described
    above.

    For an example on what you can produce with 'texi2html' have a look
    at the following sites:

    * http://www.singular.uni-kl.de/Manual/html/

    (Please send me your sites, if you'd like to have them listed here).

    Documentation of texi2html
    ==========================

    The texi2html Texinfo manual should be rather complete. In addition,
    you might want to have a look at the comments in the 'texi2html.init'
    file for explanations about customizable parameters and at the (not
    up-to-date) texi2html man page for an overview of texi2html's synopsis.

    More information
    ================

    Texi2html's home page can be found at http://www.nongnu.org/texi2html/
    The home for development is at savannah at
    http://savannah.nongnu.org/projects/texi2html

    The newest version of Texi2html can be obtained from
    http://savannah.nongnu.org/download/texi2html/
    or, via anonymous cvs (see
    http://savannah.nongnu.org/cvs/?group=texi2html for instructions).

    Send email to texi2html@nongnu.org for enhancement suggestions,
    authoring questions and general discussion.

    Send email to texi2html-bug@nongnu.org for bug reports, patches,
    discussions about code.

    To subscribe to these mailinglists, visit
      http://savannah.nongnu.org/mail/?group=texi2html
    There are no corresponding newsgroups.

    Files
    =====

    This distribution includes the following files, among others:
        README                      This file.

        NEWS                        Summary of new features by release.

        INSTALL			Generic installation instructions.

        TODO			Things which are yet to be done.

    Texi2html source files:

        texi2html                   Actual script to run. Generated by
                                    make and `buildt2h.pl' from texi2html.pl,
                                    texi2html.init, MySimple.pm, T2h_i18n.pm,
                                    l2h.init and translations.pl.

        texi2html.pl                Main source file of the converter.

        texi2html_configured.pl     File generated by `./configure' from
                                    texi2html.pl.

        texi2html.init              Default values of configurable
                                    parameters. `buildt2h.sh' inserts this
                                    file into texi2html_configured.pl when
                                    it generates the actual `texi2html' script.

        MySimple.pm                 Perl module which handles the
                                    processing of command-line options.
                                    `buildt2h.sh' inserts this file into
                                    texi2html_configured.pl when it generates
                                    the actual `texi2html' script.

        T2h_i18n.pm                 Code used to handle strings
                                    internationalization.

        translations.pl             translations of strings generated by
                                    the script `manage_i18n.pl' from source
                                    files and files in the `i18n' directory.

        l2h.init                    default configuration file for `latex2html'
                                    used to convert maths and TeX.

        i18n/                       Directory containing one file per language
                                    with translation of strings.

    Helper scripts

        manage_i18n.pl              Helper script used to regenerate translations
                                    from the source files and the files in the
                                    `i18n/' directory.

        buildt2h.sh                 Helper script used to regenerate the texi2html
                                    script. A simple wrapper around a sed
                                    one-liner.

    Documentation files:

       texi2html.texi               Texinfo manual of texi2html.

       texi2html.1.in               Template for generation of man pages
                                    of texi2html (`texi2html.1').  This man
                                    page is incomplete.

    Installation files:

        configure                   This file creates creates a Makefile
                                    which in turn creates an `info' or
                                    `makeinfo' executable, or a C sources
                                    distribution.

        configure.ac                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.

    Reporting bugs
    ==============

    For bug reports, please include enough information for the maintainers
    to reproduce the problem.  Generally speaking, that means:
    - the version number of Texi2html and the program(s) involved (use --version).
    - 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 against the
    source files (e.g., against texi2html.pl, or texi2html.init) with
    `diff -c' or `diff -u' and include ChangeLog entries.

    Good luck and enjoy !!