Compiling and Installing Xdvik
==============================

Xdvik is the kpathsea-enhanced version of xdvi. The program
invocation name is still `xdvi' for compatibility reasons.

Please submit bug reports, suggestions etc. to the sourceforge
xdvik project page:

	https://sourceforge.net/projects/xdvi/

To compile as part of a TeX Live 2019 build, replace the entire directory
Build/source/texk/xdvik in the TeX Live source tree with texk/xdvik
from this distribution (and ignore other parts of this distribution).

For other compilations, read the remainder of this file.


Note for users of installations other than TeX Live, and for those
not compiling as part of a TeX Live build:
==================================================================

   Please consult the files texk/xdvik/texmf-alt/README and
   texk/xdvik/README.t1fonts for information on how to configure
   xdvik for direct Type1 font rendering.


1. Required Software

   - X11R5 or newer and the Xt libraries

   and one of:

   - Xaw (Athena widgets)

   - Motif >= 1.2 or newer
     LessTif has a few bugs and restrictions that will result in limited
     functionality (see the file texk/xdvik/LESSTIF-BUGS for details).
     For best results, use OpenMotif 2.x.

   You need both the headers and the runtime libraries to compile and run
   xdvik (Note: Some Linux distributors may put the headers into a separate
   `X development' package).

2. Configuring:

   In the top-level directory (the directory in which this INSTALL
   file is located), invoke:

	./configure

   You can also specify a toolkit via the --with-x-toolkit option
   (the default is xaw):

	./configure --with-x-toolkit=motif [other-options]

   will compile with Xaw (Athena widgets) instead. You can set
   the search paths for Motif header/library files with the
   --with-motif-include and --with-motif-libdir options.

   If configure gives you errors about the main texmf tree not being
   found, specify its directory via the `--datadir' option.
   On a standard teTeX system, use the output of the command:

	kpsewhich --expand-path='$TEXMFMAIN'

   *without* the `texmf' component as value for `--datadir'
   (/usr/share or /usr/local/teTeX/share are possible values).

   For all configuration options available, see the output of:
       ./configure --help



3. Compiling:

   In the top-level directory, invoke:

        make

   This should compile the executable texk/xdvik/xdvi-bin

   Note that the xdvi executable is a shell script, which sets some variables
   before executing the compiled executable file xdvi-bin.

   If you set the environment variable TEXMFCNF to the path
   containing the file texmf.cfg and set TEXMFROOT to the path containing
   the texmf-dist directory, you should be able to test xdvi without
   actually installing it.

   Typical values of TEXMFCNF and TEXMFROOT might be:

	TEXMFCNF=/usr/local/texlive/2019/texmf-dist/web2c
	TEXMFROOT=/usr/local/texlive/2019

   When testing xdvi, it is best to invoke it with the arguments
   "-name xdvi"; for example:

	.../texk/xdvik/xdvi-bin -name xdvi [other-options]

   It is possible to compile xdvi from a directory outside of the source tree.
   This can be done by directly invoking the configure script.  For example,
   if xdvik is located directly within your home directory (i.e., as ~/xdvik):

	mkdir ~/build
	cd ~/build
	../xdvik/configure
	make

   Also see the file README.SVN for information about compiling only the
   texk/xdvik subdirectory.


4. Installation:

   Usually, the binary xdvi-bin is invoked by a shell wrapper
   `xdvi' which sets XDVIINPUTS and some other variables, like the X
   search path.

   If you only want to upgrade an existing version of xdvik, it should
   be sufficient to copy xdvi-bin into a directory in your PATH
   and check that the shell wrapper invokes the correct toolkit version.
   (You may also want to update the man page from xdvi.1). These files
   are located in the texk/xdvik subdirectory.

   To install a new version from scratch, invoke:

	make install

   in the top-level directory to install all executable and data files.
   This will not install the files in the texk/kpathsea subdirectory,
   which is not required if you already have a working TeX installation
   (and actually could overwrite your existing setup). If you don't have
   kpathsea installed yet, you'll need to install it manually; basically
   by doing `cd texk/kpathsea; make install'. Please see the file
   texk/kpathsea/INSTALL for more information.



5. Setup:

   Make sure that the XDVIINPUTS variable (set in the system-wide
   texmf.cnf file or in the environment, e.g. in your .profile)
   contains the path to the directory DATADIR/texmf/xdvi, and
   to the file ps2pk.map (usually in DATADIR/texmf/dvips);
   e.g. by setting:

	export XDVIINPUTS='.:$TEXMF/{xdvi,dvips}//'

   If xdvik is still generating PK versions of fonts that you think
   you have Type1 versions of, please consult texk/xdvik/README.t1fonts
   for more information on how to configure xdvik correctly for Type1
   fonts.