Index of /tex-archive/dviware/dvi2bitmap

[ICO]NameLast modifiedSizeDescription

[DIR]Parent Directory  -
[   ]AUTHORS12-Jun-2003 21:27 56
[TXT]Bitmap.cc04-Jun-2005 15:51 40K
[TXT]Bitmap.h03-Oct-2003 14:17 7.5K
[TXT]BitmapImage.cc17-Feb-2003 16:11 4.7K
[TXT]BitmapImage.h16-Feb-2003 21:48 3.2K
[TXT]Byte.h16-Feb-2003 21:48 1.5K
[TXT]COPYING04-Jun-2005 15:26 18K
[TXT]ChangeLog19-Aug-2005 16:43 5.1K
[TXT]Doxyfile.in04-Nov-2004 00:00 46K
[TXT]DviError.cc04-Jun-2005 15:51 2.0K
[TXT]DviError.h16-Feb-2003 21:48 1.7K
[TXT]DviFile.cc04-Jun-2005 15:51 48K
[TXT]DviFile.h19-Oct-2004 00:00 21K
[TXT]FileByteStream.cc04-Jun-2005 15:51 4.8K
[TXT]FileByteStream.h22-Aug-2003 15:05 1.6K
[TXT]GIFBitmap.cc04-Nov-2004 00:00 21K
[TXT]GIFBitmap.h17-Feb-2003 16:11 3.7K
[TXT]INSTALL04-Jun-2005 15:26 9.3K
[TXT]InputByteStream.cc04-Jun-2005 15:51 26K
[TXT]InputByteStream.h04-Nov-2004 00:00 6.1K
[TXT]KarlPathSearcher.cc04-Nov-2004 00:00 10K
[TXT]KarlPathSearcher.h03-Aug-2003 22:54 2.2K
[TXT]Makefile.am19-Aug-2005 16:42 2.9K
[TXT]Makefile.in21-Aug-2005 17:18 33K
[   ]NEWS12-Jun-2003 21:27 34
[TXT]PNGBitmap.cc08-Jun-2005 12:21 15K
[TXT]PNGBitmap.h17-Feb-2003 16:11 2.0K
[TXT]PageRange.cc04-Jun-2005 15:51 7.1K
[TXT]PageRange.h16-Feb-2003 21:48 1.8K
[TXT]PipeStream.cc04-Jun-2005 15:51 19K
[TXT]PipeStream.h06-Aug-2003 23:34 2.3K
[TXT]PkFont.cc04-Jun-2005 15:51 37K
[TXT]PkFont.h03-Oct-2003 14:26 14K
[TXT]README16-Jan-2005 00:00 5.9K
[TXT]TODO09-Sep-2004 00:00 2.2K
[TXT]Util.cc04-Jun-2005 15:51 5.6K
[TXT]Util.h06-Aug-2003 23:13 1.7K
[   ]VERSION21-Aug-2005 17:21 5
[TXT]XBMBitmap.cc04-Jun-2005 15:51 2.8K
[TXT]XBMBitmap.h16-Feb-2003 21:48 1.6K
[TXT]XPMBitmap.cc04-Jun-2005 15:51 2.8K
[TXT]XPMBitmap.h16-Feb-2003 21:48 1.6K
[TXT]aclocal.m421-Aug-2005 17:18 244K
[TXT]config.guess04-Jun-2005 15:25 43K
[TXT]config.h.in21-Aug-2005 17:18 7.9K
[TXT]config.sub04-Jun-2005 15:25 31K
[TXT]configure21-Aug-2005 17:18 764K
[TXT]configure.ac19-Aug-2005 16:43 23K
[TXT]depcomp04-Jun-2005 15:26 15K
[DIR]doc/23-Aug-2005 20:06 -
[DIR]doc_libdvi2bitmap/19-Jan-2004 10:59 -
[TXT]dvi2bitmap.127-Oct-2003 15:18 29K
[TXT]dvi2bitmap.cc04-Jun-2005 15:51 50K
[TXT]dvireport.126-Sep-2003 23:41 2.3K
[TXT]dvireport.cc04-Jun-2005 15:51 5.1K
[TXT]getopt_long.c19-Feb-2003 10:04 34K
[TXT]getopt_long.h19-Feb-2003 10:07 6.1K
[TXT]getsubopt.c18-Feb-2003 10:50 2.7K
[DIR]html/23-Aug-2005 20:06 -
[TXT]install-sh04-Jun-2005 15:26 9.0K
[   ]ltmain.sh04-Jun-2005 15:25 182K
[TXT]missing04-Jun-2005 15:26 11K
[TXT]stringstream.h04-Nov-2004 00:00 1.8K
[DIR]test/23-Aug-2005 20:06 -
[TXT]verbosity.h15-Jun-2003 18:55 2.1K
[TXT]version.h.in12-Jun-2003 21:27 50


dvi2bitmap
==========

dvi2bitmap is a utility to convert TeX DVI files directly to bitmaps,
without going through the complicated (and slow!) route of conversion
via PostScript and PNM.  The prime motivation for this is to prepare
mathematical equations for inclusion in HTML files, but there are
plenty of uses beyond that.  It uses the same kpathsea font-searching
library as other TeX programs, again as long as you have the
appropriate library installed.

Features:

  * Written in C++.

  * The program is a wrapper for libdvi2bitmap, a library which abstracts
    DVI and PK files, Bitmaps, and various other objects supporting
    these.

  * Supports GIF, XBM, XPM bitmaps as output, plus PNG if libpng is
    installed.

  * Can read DVI files from a non-seekable stream such as a pipe.

  * Internally constructed bitmap is expandable.

  * Integrated with the kpathsea path-searching algorithm, as used by other
    TeX and DVI programs.  It is not, however, dependent on it, so it
    will still work happily if you don't have the library installed.
    Can use a pre-set search path, or scripts, to find fonts instead.

  * Can generate fonts on the fly.

  * Highly configurable, and very fast.  Designed for use in a batch
    production mode.

  * Released under the GPL.


See <http://www.astro.gla.ac.uk/users/norman/star/dvi2bitmap/>

Configuring and building
------------------------

To configure and build:

    ./configure
    make
    make install

You can override the C++ compiler the configure script will choose by
setting the environment variable CXX, either via `CXX=cxx ./configure'
or `env CXX=cxx ./configure', depending on your shell.  Choose the
install location with the argument --prefix.

Since this program uses `standard' TeX fonts, but at resolutions
appropriate for screens rather than paper, there is a certain fuss
involved in generating, and after that, finding, these fonts.  If you
have the `kpathsea' library installed, then this should Just Work.
Failing that, you might have to set an environment variable.  See the
section of the manual entitled `Finding fonts' for some discussion of
this.  As well, it's a good idea to give the command

    (cd test; make)

after you've built the distribution.  As well as testing the program,
this attempts to give you some advice about what you need to do on
your particular system to tell dvi2bitmap where its fonts are.

If you want it to be able to generate GIFs, then give the configure
option `--enable-gif'.  Starting in 2005, this is enabled by default,
since the Unisys patents appear to have expired in 2004.  You can
disable the ability to generate GIFs (probably a good plan, if you
have the PNG library available) with the option `--disable-gif'.

If you want it to be able to generate PNG files (much better, since
they're free of the GIF copyright problems), then give the configure
option `--with-png'; if you don't have libpng in the default places
(typically /usr/lib or /usr/local/lib), then instead use
`--with-png=/path/to/png', where the specified path is that to the
directory which contains the png include/ and lib/ directories.  This
will check you have the libpng library and headers somewhere the
compilers can find them, and build in support if it finds them.  The
PNG library is not distributed with this utility: you can find it at
<http://www.libpng.org/pub/png/>.

The program can work with the kpathsea library.  This is the same
path-searching library which several TeX implementations use to find
fonts (and more).  If you wish to use this (you should, if you can),
then give the option `--with-kpathsea' to the configure command, again
optionally specifying a path, and if the library is installed on your
machine, the program will use it.  The kpathsea library is distributed
as part of the web2c (Unix TeX source) distribution, which you can
find at <ftp://ftp.tug.org/tex/web2c.tar.gz>, or mirrored on CTAN
sites (for example at <http://www.tex.ac.uk> in directory
systems/web2c).  The dvi2bitmap manual includes a brief discussion of
obtaining and building this library.

The program builds successfully on (at least) the following
machine/compiler combinations.  It should be written in
standards-conforming C++, so if it doesn't build then (1) it's not as
conformant as I think it is (in which case please tell me), (2) your
compiler is not as conformant as you think it is (in which case please
don't tell me), or (3) you need to invoke some magic to get the
compiler to be conformant (in which case tell me, if there's something
I can do in the autoconfigure script).

    powerpc-apple-darwin6.6 (MacOS X, 10.2.6)
        g++ 3.1 20020420 (prerelease)

    sun-sparc-solaris2.9
        CXX=CC: Sun WorkShop 6 update 2 C++ 5.3 2001/05/15

    alphaev67-dec-osf5.1
        CXX=cxx: Compaq C++ V6.5-014

    i686-pc-linux-gnu (RedHat 7.3)
        g++ 2.96


Font-string templates
---------------------

Several things which can be configured -- either at ./configure-time
or in the config.h file, if you have to edit that explicitly -- are
specified as being in the form of a `font string
template'.  This is a printf-like string which has %? specifiers
replaced by font parameters, according to the following scheme:
  %M = mode (eg. ibmvga)
  %f = font name (eg. cmr10)
  %d = dpi (eg. 330)
  %b = base dpi (eg. 110)
  %m = magnification (eg. 3)
  %% = %

This applies to the font-generation script and font-search scripts.

Documentation
-------------

See directory doc/ -- there are fuller installation instructions
there.  Full library documentation in directory doc_libdvi2bitmap/.
There's also a man-page in dvi2bitmap.1, but this is not 
necessarily as up-to-date as the main documentation.


Author
------

Norman Gray
http://www.astro.gla.ac.uk/users/norman/
norman@astro.gla.ac.uk


Copyright
---------

Copyright 1999--2003, Council for the Central Laboratories of the
Research Councils.  Released under the terms of the GPL, a copy of
which is included in the file LICENCE.


$Id: README,v 1.23 2005/01/16 20:57:00 nxg Exp $