summaryrefslogtreecommitdiff
path: root/Build/source/utils/texi2html/README
blob: ee5a2027ec11f3d031272e2fc458ce3fbfafcbfe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
This is the README file for the GNU texi2html distribution.
The primary distribution point is
http://texi2html.cvshome.org/servlets/ProjectDownloadList

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 or higher installed on your system
  to run 'texi2html'.
* To generate Makefile.in etc., run `./autogen.sh'

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

    NEWS                        Summary of new features by release.

    INTRODUCTION                Brief introduction to texi2html and
                                its usage.

    INSTALL			Generic installation instructions.

    TODO			Things which are yet to be done.

Texi2html source files:

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

    texi2html.pl                Main source file of the converter.

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

    MySimple.pm                 Perl module which handles the
                                processing of command-line options. 
                                `configure' inserts this file into
                                texi2html.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.

Documentation files:

   texi2html.texi               Texinfo manual of texi2html. This
                                manual is currently under construction.

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


WWW home page:
http://texi2html.cvshome.org

Mailing lists:
- users@texi2html.cvshome.org for enhancement suggestions, 
  authoring questions and general discussion.
  to subscribe to this mailinglist, visit
  http://texi2html.cvshome.org/servlets/ProjectMailingListList
  or send mail to users-subscribe@texi2html.cvshome.org .
- dev@texi2html.cvshome.org for bug reports, patches, discussions
  about code.
There are no corresponding newsgroups. 

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.