GLE 4.0 README

This document contains instructions on how to install
and/or build GLE4.  see section below

Supported platforms: Windows, Linux, Mac OS/X, Unix, OS/2

===============================================================================

Installation instructions for GLE 4.0 (Windows)

Since you are reading this you downloaded the do it yourself .zip package for gle installation. To install this
package:

1) unzip gle4_win32_exe_x.y.z.zip

This will create the following directory tree where you unziped the files

gle4
gle4\bin
gle4\font
gle4\lib

2.) Add gle4\bin to your PATH, prepended with the path you unziped the files in.
E.g., c:\program files\gle4\bin

3.) Make GLE find its installation directory and optionally also the directories of other programs it may use (i.e.,
GhostScript and LaTeX). This is accomplished by running "gle -finddeps [path]" in a command prompt, where path is the
place to search ("C:\Program Files" is the default).

C:>gle -finddeps
Finding dependencies in: C:\Program Files: ........................
Found: gle.exe in 'C:\Program Files\gle4\bin'
Found: gswin32c.exe in 'C:\Program Files\Tools\gs\gs\gs8.00\bin'
Found: latex.exe in '?'
Found: dvips.exe in '?'

In the example above, GLE has found out that it is installed in "C:\Program Files\gle4" and that GhostScript
(http://www.cs.wisc.edu/~ghost/doc/AFPL/index.htm) is in "C:\Program Files\Tools\gs\gs\gs8.00\bin". Note that this
version of GLE does not require you to set GLE_TOP. Once the installation directory has been found, it is stored in
the registry for further use.

4.) LaTeX is usallly not installed in "C:\Program Files", so a second -findeps is required to locate it. The following
example assumes the MiKTeX distribution is installed.

C:>gle -finddeps "C:\MiKTeX"
Finding dependencies in: C:\MiKTeX: ...........................
Found: gle.exe in 'C:\Program Files\gle4\bin'
Found: gswin32c.exe in 'C:\Program Files\Tools\gs\gs\gs8.00\bin'
Found: latex.exe in 'C:\MiKTeX\Main\miktex\bin'
Found: dvips.exe in 'C:\MiKTeX\Main\miktex\bin'

Note that both GhostView and LaTeX are optional. For creating simple .eps graphs, they are not required, i.e., GLE
will still work if you see question marks for gswin32c.exe, latex.exe and dvips.exe.

5.) you are all set. Enjoy.

===============================================================================

Installation instructions for GLE 4.0 (OS/2)

Since you are reading this you downloaded the do it yourself .zip package for gle installation. To install this package:

1) Unzipping gle-4.0.x.zip will create the following files

gle\
gle\doc\readme		(you are reading this)
gle\doc\gle-manual.pdf
gle\gle.exe
gle\libc06b4.dll
gle\fbuild.exe
gle\makefmt.exe
gle\inittex.ini
gle\glerc.sample.os2
gle\font\*

2) Put gle.exe somewhere into your PATH and libc06b4.dll into your LIBPATH.

3) Add "SET GLE_TOP=x:/path/gle" to your config.sys.

4) The sample configuration file (glerc.sample.os2) can be used to change the defaults. Modify it and put a copy of
   it into your home directory: %HOME%\.glerc.

===============================================================================

Running GLE 4.0 (All platforms)

gle -d outputtype yourfile.gle

where outputtype is one of: eps, teps, ps, pdf, jpg, png

see the GLE manual for more information
<http://glx.sourceforge.net/>

contact the glx-general mailing list if you have any questions
<https://lists.sourceforge.net/lists/listinfo/glx-general>

===============================================================================

Build instructions for GLE 4.0

Both the windows and unix build process use makefiles. Visual Studio project
files and unix autoconf and automake are not supported since they are platform
specific.  makefiles and config files ending in .vc are for microsoft visual C++
compiler. Makefiles and config files ending in .gcc are for the gcc compiler.
Config files ending in .i and files ending in .txt such as files.txt are for
both compilers and define common macros.

If you have another compiler or target system please add the makefiles
and config files.  Note that each directory in the src directory needs its own
makefile

-------------------------------------------------------------------------------

To build gle:

Dependencies:

the code is written using C++ and

requires the Boost library www.boost.org you must also have the environment
variable BOOSTDIR point to the location of you boost installation.

to compile GLE with support for including bitmap files
	libtiff <www.libtiff.org> and
	libpng <www.libpng.org>
are required and in config.i
	HAVE_LIBTIFF = 1
	HAVE_LIBPNG = 1
must be enabled (to disable support, comment these out with '#')

1) Define the environment variable GLE_TOP to point to your the location of
the PROJECT_BINDIR most likely c:\sandbox\gle4\bin

2) Compile the sources

Windows (with Microsoft Visual C++):
	you must have the environment variable LIBTIFFDIR point to the location
	of the libtiff.h and .lib files

	you must have the environment variable LIBPNGDIR point to the location
	of the png.h and .lib files

	nmake -f Makefile.vc

Linux/Cygwin/Unix:
	optionally change the values of
		INSTALL_DIR   (default =/usr/share/gle)
		INSTALL_BIN   (default =/usr/bin)
	in config.gcc

	export GLE_TOP=/path/to/gle4/bin
	export BOOSTDIR=/path/to/boost/library

	make -f Makefile.gcc
	su
	make -f Makefile.gcc install

Mac OS/X
	follow same instructions as for Linux/Cygwin/Unix
	but add "-D BIGINDIAN" to the CXXFLAGS line of config.gcc

OS/2 (with gcc 3.2.2)
	optionally change the values of
		BOOSTDIR        (default E:/Work/Projects/CGLE/boost_1_30_0)
		INSTALL_DIR     (default x:/usr/share/gle)
		INSTALL_BIN     (defualt x:/usr/bin)
        in config.os2

        make -f Makefile.os2

This will build:

gle(.exe) : GLE main executable
fbuild(.exe) : makes *.fve fron *.gle using fbuild in the src\font directory
makefmt(.exe) : makes font files *.fmt from *.afm in the src\font directory

This will also run the fbuild and makefmt commands and put the
font files in the gle\bin\font along with the font.dat file

This will also run your newly built gle on the files
in the src\samples subdirectory

the clean target is also defined on all makefiles

===============================================================================

Source code organization:

the source code is contained in the src sub directory, where each module has its
own directory (and makefiles). binaries are put in the bin sub directory.



Enjoy

-Vince

