INSTALLING TKDVI
================

Prerequisites
-------------

For TkDVI you need the following software packages:

- Tcl/Tk 8.0 (see http://www.scriptics.com/). Older versions will *not*
  work. Tcl/Tk 8.1 will quite likely work but I haven't tried it yet.

- Kpathsea library from Web2C 7.x. If you have teTeX 0.9 or later you
  should have it around somewhere or be able to obtain it. In doubt,
  see http://www.dante.de/.

These must be installed on your system in order for the TkDVI build
process to succeed.


Configuration and Installation
------------------------------

TkDVI uses the GNU autoconf mechanism to adapt itself to your system.
Rather than write it all up myself, I've included a generic
description of autoconf-based configuration in the file
INSTALL.generic. (This is from Automake 1.3 as contained in the Debian
GNU/Linux package.)

TkDVI's configure script contains a number of special options, namely:

  --enable-debug	to enable support for the automatic regression
			test suite used in `make check'. Turn this on
			if you want to run the regression tests.

  --with-tcldir=DIR	to use the Tcl library in directory DIR. The
			configure script tries to derive the directory
			of tcl.h from this directory as well. This
			defaults to `/usr/lib'.

  --with-tkdir=DIR	to use the Tk library in directory DIR. The
			comment in the previous paragraph applies to
			tk.h. This defaults to wherever Tcl was found.
			Say `--with-tkdir=no' to build TkDVI with no
			Tk support (so you can load the extension
			from a tclsh).

  --with-kpathsea=DIR	to use the Kpathsea library in directory DIR.
			This should be the directory where the
			`libkpathsea.a' file is located. This defaults
			to `/usr/lib'.

The normal way would be to use `make install' to install TkDVI to a
directory hierarchy such as `/usr/local'. You can run TkDVI from
the compilation directory but you must invoke a `wish' explicitly
since the `tkdvi' script is only made executable by `make install'.
Also you need to make sure that TkDVI will find the dvi extension
and its Tcl files:

  $ export TKDVI_BINLIB=`pwd`/dvi/.libs
  $ export TKDVI_TCLLIB=`pwd`/lib
  $ wish ./tkdvi testdvi/mini

(After the `make install', `tkdvi testdvi/mini' should be sufficient
-- the environment variables are mostly for testing.)

Testing
-------

There is an incomplete regression test suite in the `tests'
subdirectory of the distribution. Use `make check' from the
compilation directory to run the tests -- note that you must have
said `--enable-debug' during configuration to be able to run the
test suite successfully! (See above.)

The tests that deal with font files may fail because your system
does not use the same sort of fonts as mine.

$Id: INSTALL,v 1.2 1999/06/10 12:44:30 lingnau Exp $