Installation

First go to the download page to get the latest distribution and unpack it.

If you downloaded the source distribution, you need at least the following to build the executable:

• Troll Tech's GUI toolkit Qt .
• The GNU tools flex, bison and make
• In order to generate a Makefile for your platform, you need perl .

For platform specific installation instructions see the INSTALL file that is included in the package.

To use the search engine doxysearch, you will also need a HTTP daemon running on the target system and permission to execute a CGI binary.

If you are running Unix, and have Qt installed correctly, you can simply enter

configure

to set up the makefiles for your platform. For Windows this step can be skipped.

To override the auto detected platform you can specify

configure --platform platform-type

See the file PLATFORMS for a list of possible platforms. For more configuration options use configure --help

To compile and link the sources enter

make

in the root of the distribution. Doxygen should compile without errors or warnings. If it does not, please send the compilation errors or warnings along with a description of your platform to dimitri@stack.nl.

After compilation, the binaries will be located in the bin directory of the distribution. You may want to copy these files to a location in your path (/usr/local/bin for instance) or add the bin directory of the distribution to your search path.

On Unix you can also type:

make install

The following binaries should now be available:

• doxygen: for generating the class browser.
• doxytag: for creating a tag file containing references to external documentation.
• doxysearch: the search engine. This binary should not be executed directly. It must be called from an CGI script that will be generated by doxygen.

Doxygen was developed and tested under Linux using the following tools:

• EGCS version 2.91.66
• GNU flex version 2.5.4
• GNU bison version 1.25
• GNU make version 3.76.1
• Perl version 5.005_02
• VIM version 5.4
• Netscape 4.61
• Troll Tech's tmake version 1.3 (included in the distribution)
• teTeX version 0.9
• CVS 1.10.7

Go to the next section or return to the index.

---