← Back to branch summary

~ubuntu-branches/debian/sid/tex4ht/sid

« back to all changes in this revision

Viewing changes to debian/README.Debian

  • Committer: Bazaar Package Importer
  • Author(s): Kapil Hari Paranjape
  • Date: 2005-04-05 14:14:41 UTC
  • mfrom: (1.2.1 upstream) (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050405141441-x4dojdgz3frkfyet
Tags: 20050402.1817-1
http://bugs.debian.org/299934
http://bugs.debian.org/295109
http://bugs.debian.org/219348
http://bugs.debian.org/219347
* New upstream release (2005-04-02-18:17). Closes: #299934.
* See README.src, README.validate, README.Debian and copyright
  for information on minor changes.
* This upload fixes a some .htf files. Closes: #295109.
* Updated the description to reflect recent changes.
* Fixed some typos in src/tex4ht-mkht.tex and consequently
  in the mk4ht script.
* Updated the man page to include mk4ht. 
* Updated the description of options for the scripts in the man page.
  Put more information in the man page about the way the system works.
  Closes: #219348, #219347.
* Added debian/watch file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/README.Debian
1
 
tex4ht for DEBIAN - packaging notes
2
 
-----------------------------------
 
1
tex4ht for DEBIAN - packaging notes - revised for v.20050331.2350
 
2
------------------------------------------------------------
3
3
 
4
4
Each file in the tex4ht system has a version date recorded within it.  The
5
 
version of this Debian package is 20011214, based on the date of the latest
6
 
source file within it.  The version dates of the main source and style files
7
 
are as follows:
8
 
        tex4ht.c        2001-10-17
9
 
        t4ht.c          2001-07-16
10
 
        tex4ht.sty      2001-12-14
11
 
        *.htf           2001-12-10
12
 
        *.4ht           2001-12-14
13
 
 
14
 
There are no original manual pages for tex4ht, but I have written a page based
 
5
version of this Debian package is 20050331.2350, based on the upstream 
 
6
authors numbering scheme---suitably Debian-ized.
 
7
The version dates of the main source and style files are as follows:
 
8
 
 
9
        tex4ht.c        2005-02-21-18:57
 
10
        t4ht.c          2005-02-21-19:12
 
11
        tex4ht.sty      2005-03-25-09:49
 
12
 
 
13
The author has responded to comments on the Debian bugs archive regarding
 
14
the availability of the literate programming source. Please see README.src
 
15
in this directory for details.
 
16
 
 
17
In addition to the substantial work (see below) done by the previous maintainer
 
18
Andrew Gray (many, many thanks to him wherever he is now), the following features
 
19
in the new source were exploited. 
 
20
 
 
21
        (1) The LGTYP variable was defined in Andrew's Makefile 
 
22
            so that PNG is the default graphic format instead of GIF.
 
23
        (2) The new tex4ht.env allows for multiple tagged sections of
 
24
            possible ways to create graphics. The default one
 
25
            creates PNG's using dvipng.
 
26
 
 
27
On configuration
 
28
================
 
29
 
 
30
The configuration file for tex4ht is searched for by kpathsearch library
 
31
routines. You can put this file in the following places (see
 
32
README.kpathsea for details).
 
33
 
 
34
        $PWD/tex4ht.env, $PWD/.tex4ht, $HOME/tex4ht.env, $HOME/.tex4ht
 
35
        /usr/share/texmf/tex4ht/tex4ht.env
 
36
 
 
37
The last file is provided by the package as a symlink to
 
38
/etc/tex4ht/tex4ht.env in keeping with the Debian convention on
 
39
configuration files. This file differs from the upstream version only in
 
40
the graphics conversion section. It is somewhat self documenting.
 
41
 
 
42
On graphics conversion
 
43
======================
 
44
 
 
45
As explained at the top of /etc/tex4ht/tex4ht.env, suitable tags
 
46
can be used select the named sections of the graphics conversion process.
 
47
Please examine the top of that file to understand its format.
 
48
 
 
49
The graphics sections provided are default, upstream and netpbm.
 
50
 
 
51
The default scripts (htlatex and friends) for converting TeX/LaTeX to
 
52
HTML only convert graphics to PNG.
 
53
 
 
54
If you explicitly ask for non-PNG graphics then the configuration file
 
55
always depends on the imagemagick suite to perform conversion.
 
56
 
 
57
The default conversion method uses only dvipng for conversion to PNG.
 
58
 
 
59
The upstream conversion method uses the imagemagick suite. If you wish
 
60
to use many different types of graphics outputs this may be your best
 
61
choice. Note that convert also depends on a suitable ghostscript for the
 
62
initial conversion from postscript to bitmap. This method also offers
 
63
a way to convert figures to SVG using pstoedit.
 
64
 
 
65
The upstream conversion method also has a commented out (with
 
66
spaces!) a method that uses the "pngalpha" driver which is available
 
67
with ghostscript 8.14 and higher; if you wish to use this then remove
 
68
the spaces in front of it. A further commented out section (tagged
 
69
KHP) uses "pnggray" which does not have transparency. If you only have
 
70
access to gs 8.01 then use this instead of the line on top. Note that
 
71
gs-esp version 7.xx does not currently crop images correctly and results
 
72
in awful HTML pages.
 
73
 
 
74
There is another commented out method which is an older version of
 
75
the imagmagick method. If you have an older imagemagick you may want
 
76
to use this.
 
77
 
 
78
The netpbm conversion method uses the netpbm suite.
 
79
 
 
80
Kapil Hari Paranjape <kapil@imsc.res.in>
 
81
Sat,  2 Apr 2005 09:03:04 +0530
 
82
 
 
83
Original Maintainer's notes
 
84
===========================
 
85
 
 
86
<KHP's note: What follows below is a major portion of the original
 
87
README.Debian. The "I" in the sentences below refers to Andrew Gray>
 
88
 
 
89
There are no original manual pages for tex4ht, but I wrote a page based
15
90
on the HTML documentation.  The user-guide consists of HTML documentation
16
91
which is available in /usr/share/doc/texmf/tex4ht.  Start with file mn.html
17
92
(or index.html) in your web browser.
18
93
 
19
 
The original source did not include a Makefile, so I have written one.
 
94
The original source did not include a Makefile, so I have written one (with
 
95
the program sources, in the temp/ subdirectory of the source package).  This
 
96
has been simplified in v.20030426, partly because the source tex4ht files are
 
97
organised in a directory structure closer to the typical web2c structure.
20
98
 
21
99
The Debian versions of tex4ht and t4ht are built with the 'kpathsea'
22
100
file-search library, as used by tex and other programs in the package
23
101
tetex-bin.  See the file README.kpathsea in this directory for notes on how
24
 
tex4ht can be configured using the global kpathsea configuration file.
25
 
 
26
 
I have slightly reorganised the files from the original sources in zip file
27
 
tex4ht.zip:
28
 
   doc/win95/:  Windows-95 files, deleted
29
 
   doc/share/:  moved to share/
30
 
 
31
 
The 'bug-fix' files in newt4ht.zip have overwritten the equivalent files from
32
 
tex4ht.zip.  All files have been chmod'ed u+w (many are read-only when
33
 
unpacked).
34
 
 
35
 
I have made the following changes to the default configuration files,
36
 
'tex4ht.env':
37
 
 
38
 
        1. Instructed tex4ht to produce .png files instead of .gif for maths
39
 
        characters etc ('g' option), in keeping with Debian's free software
40
 
        philosophy.  Note that you will also need the 'png' option in the
41
 
        tex/latex configuration file or '\Preamble...' command (see manual),
42
 
        to request .png files instead of .gif for pictures that you generate.
43
 
        2. Commented out path-searching lines and the cache (or `bookkeeping')
44
 
        file option, as these are taken care of by the kpathsea library.
 
102
tex4ht can be configured using the global kpathsea configuration file.  Note
 
103
that because the programs are built with kpathsea, the path-searching and
 
104
bookkeeping file options within the tex4ht.env configuration file ('t', 'i'
 
105
and 'l' lines) are redundant and/or will be interpreted in special ways (see
 
106
README.kpathsea for details).
 
107
 
 
108
The 'bug-fix' files (in newt4ht.zip) and new htf fonts (in htf.zip) have
 
109
overwritten the equivalent files from tex4ht.zip.
 
110
 
 
111
In keeping with Debian's free software philosophy, I have altered the
 
112
configuration file and scripts to generate PNG rather than GIF files by
 
113
default.  The alterations are as follows:
 
114
 
 
115
 - in tex4ht.env config file:  altered 'g' line to 'g.png', to generate PNG
 
116
   files for any symbol characters that are used in your document
 
117
 
 
118
 - in the htlatex-like scripts (httex, httexi and htlatex in /usr/bin/httex, 
 
119
   and scripts in /usr/share/tex4ht), add 'png' option to the
 
120
   tex/latex commands, to generate PNG files for any pictures specifically
 
121
   requested in your document
45
122
 
46
123
Note that, if you do not have the imagemagick package installed, you will have
47
124
to adjust the 'G' lines towards the end of the configuration file
48
 
'/etc/tex4ht/tex4ht.env'.  See the HTML documentation for more details.
 
125
/etc/tex4ht/tex4ht.env.  See the HTML documentation for more details, or the
 
126
comments within tex4ht.env:  the version of tex4ht.env currently shipped with
 
127
the package includes (commented out) versions of these lines for netpbm-users.
49
128
 
50
129
For more details on the configuration of tex4ht, see the HTML documentation.
51
130
Note that the HTML documentation and the test files are placed under
52
131
/usr/share/doc/texmf/tex4ht.
53
132
 
54
 
If you are upgrading from an earlier Debian tex4ht package, you may want to
55
 
read the notes in file README.upgrading.
 
133
If you are upgrading from a Debian tex4ht package earlier than v.20000703, you
 
134
may want to read the notes in file NEWS.Debian.
56
135
 
57
136
Andrew Gray <ajpg@debian.org>, 
58
 
Sun, 16 Dec 2001 14:23:44 +0000
 
137
Fri,  2 May 2003 22:22:03 +0100
 
138
--