Installation Instructions

Compilation Prerequisites

The only third-party library this application requires is the Simple DirectMedia Layer, available for most platforms at http://www.libsdl.org. Note that although the configure script checks for SDL 1.2.0 or higher, in practice the application has only been tested with SDL 1.2.5.

Compiling GFW

Under any Unixes (OS X, Cygwin32, linux), it's not hard.

./configure
make
make install

Running the Test Program

1. Go into the release directory.
2. Depending on your OS, run either gfw (Unix/MacOSX) or gfw.exe.

Note that in this project, make install has been rewritten to copy all essential program files into the release directory.

Similarly, make uninstall deletes the release directory and everything inside it.

Cross-platform Compatibility

The GFW test program has been compiled and run successfully on the following platforms and compilers:

• MacOS X 10.2 ("Jaguar") using gcc 3.1
• RedHat Linux 8.0 ("Psyche") using gcc 3.2
• Windows 2000 using Microsoft Visual C++ .NET 2002
• Windows 2000 using Cygwin and gcc 3.2

Additionally, GFW has run successfully on the following platforms:

• Windows 98
• Windows XP

MacOS X Notes

Don't download the precompiled SDL OS X development package; this installs an OS X framework that can be used with Apple's Project Builder, but it doesn't seem to be compatible with the Unix library version of SDL that the configure/make cycle uses. So download the source to the SDL library, compile, and install it.

Windows Notes

If you are using Windows, the configure/make cycle won't work unless you're using Cygwin32 and have the SDL library installed under it.

If you want to compile Pman under Win32 using Visual C++ .NET, use the project contained in the VisualC directory. You will also need to make sure you have the SDL library and include paths set up in your project or global preferences. Note that you may have some problems if you can't run the ./configure script, because this script automatically generates some of the input files.

If you have Cygwin32 but don't have the SDL library, you can still maintain the package (although you can't compile it unless you go the MSVC++ route). To do this, run configure with the --disable-sdl option. This will allow configure to create a makefile, but you won't be able to actually compile the binary via make. You can, however, make any modifications to the package and use make dist to re-distribute the modified package. If you do this, make sure you're using the ntea option with Cygwin so that POSIX file permissions are preserved.

Other Notes

If you're using the gcc compiler, you may get warnings claiming:

'class XXX' only defines a private destructor and has no friends.

You can safely ignore these, as these classes are singletons that have static public methods which call their destructors. These warnings have actually been altered in the latest snapshot of gcc to say:

'class XXX' only defines a private destructor and has no friends
and no static public methods.

See the following URL for more information:

http://gcc.gnu.org/ml/gcc-bugs/1998-10/msg00033.html

Generating the Documentation

If you want to dynamically generate the documentation you're reading now, run make docs. This will run Doxygen, put the documentation in the docs/html directory, and make a gzipped tarball in the root project directory. Note this assumes that doxygen and dot (AT&T's graphviz tool) are both in your path.

You can get Doxygen here and graphviz here.

Alternatively, you can edit the docs/doxyconf-html file and tell it not to use the graphviz tool, although this will remove a lot of cool charts and collaboration info (but it makes the documentation render a lot faster, too).

---