Installation

First go to the download page to get the latest distribution, if you did not have it already.

This section is divided into the following sections:

Compiling from source on Unix

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

To take full advantage of doxygen's features the following additional tools should be installed.

Compilation is now done by performing the following steps:

  1. Unpack the archive, unless you already have done that:

        gunzip doxygen-$VERSION.src.tar.gz    # uncompress the archive
        tar xf doxygen-$VERSION.src.tar       # unpack it
    

  2. Run the configure script:

        sh ./configure
    

    The script tries to determine the platform you use, the make tool (which must be GNU make) and the perl interpreter. It will report what it finds.

    To override the auto detected platform and compiler you can run configure as follows:

        configure --platform platform-type
    

    See the PLATFORMS file for a list of possible platform options.

    If you have Qt-2.1.x installed and want to build the GUI front-end, you should run the configure script with the --with-doxywizard option:

        configure --with-doxywizard
    

    For an overview of other configuration options use

        configure --help
    

  3. Compile the program by running make:

        make
    

    The program should compile without problems and three binaries (doxygen, doxytag, and doxysearch) should be available in the bin directory of the distribution.

  4. Optional: Generate the user manual.

        make docs
    

    To let doxygen generate the HTML documentation.

    Note:
    You will need the stream editor sed for this, but this should be available on any Unix platform.
    The HTML directory of the distribution will now contain the html documentation (just point a HTML browser to the file index.html in the html directory).

  5. Optional: Generate a PDF version of the manual (you will need pdflatex, makeindex, and egrep for this).

        make pdf
    

    The PDF manual doxygen_manual.pdf will be located in the latex directory of the distribution. Just view and print it via the acrobat reader.

Installating the binaries on Unix

After the compilation of the source code do a make install to install doxygen. If you downloaded the binary distribution for Unix, type:

    ./configure
    make install

Binaries are installed into the directory <prefix>/bin. Use make install_docs to install the documentation and examples into <docdir>/doxygen.

<prefix> defaults to /usr but can be changed with the --prefix option of the configure script. The default <docdir> directory is <prefix>/share/doc/packages and can be changed with the --docdir option of the configure script.

Alternatively, you can also copy the binaries from the bin directory manually to some bin directory in your search path. This is sufficient to use doxygen.

Note:
You need the GNU install tool for this to work (it is part of the fileutils package). Other install tools may put the binaries in the wrong directory!
If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages.

Known compilation problems for Unix

Qt problems

The Qt include files and libraries are not a subdirectory of the directory pointed to by QTDIR on some systems (for instance on Red Hat 6.0 includes are in /usr/include/qt and libs are in /usr/lib).

The solution: go to the root of the doxygen distribution and do:

   mkdir qt
   cd qt
   ln -s your-qt-include-dir-here include
   ln -s your-qt-lib-dir-here lib
   export QTDIR=$PWD

If you have a csh-like shell you should use setenv QTDIR $PWD instead of the export command above.

Now install doxygen as described above.

Bison problems

Versions 1.31 to 1.34 of bison contain a "bug" that results in a compiler errors like this:

ce_parse.cpp:348: member `class CPPValue yyalloc::yyvs' with constructor not allowed in union

This problem has been solved in version 1.35 (versions before 1.31 will also work).

Latex problems

The file a4wide.sty is not available for all distributions. If your distribution does not have it please select another paper type in the config file (see the PAPER_TYPE tag in the config file).

HP-UX & Digital Unix problems

If you are compiling for HP-UX with aCC and you get this error:

    /opt/aCC/lbin/ld: Unsatisfied symbols:
    alloca (code)
then you should (according to Anke Selig) edit ce_parse.cpp and replace
    extern "C" {
      void *alloca (unsigned int);
    };
with
    #include <alloca.h>  

If that does not help, try removing ce_parse.cpp and let bison rebuild it (this worked for me).

If you are compiling for Digital Unix, the same problem can be solved (according to Barnard Schmallhof) by replacing the following in ce_parse.cpp:

    #else /* not GNU C.  */
    #if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) \
        || defined (__sparc) || defined (__sgi)
    #include <alloca.h>

with

    #else /* not GNU C.  */
    #if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) \
        || defined (__sparc) || defined (__sgi) || defined (__osf__)
    #include <alloca.h>

Alternatively, one could fix the problem at the bison side. Here is patch for bison.simple (provided by Andre Johansen):

--- bison.simple~       Tue Nov 18 11:45:53 1997
+++ bison.simple        Mon Jan 26 15:10:26 1998
@@ -27,7 +27,7 @@
 #ifdef __GNUC__
 #define alloca __builtin_alloca
 #else /* not GNU C.  */
-#if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) \
     || defined (__sparc) || defined (__sgi)
+#if (!defined (__STDC__) && defined (sparc)) || defined (__sparc__) \
     || defined (__sparc) || defined (__sgi) || defined (__alpha)
 #include <alloca.h>
 #else /* not sparc */
 #if defined (MSDOS) && !defined (__TURBOC__)

The generated scanner.cpp that comes with doxygen is build with this patch applied.

Sun compiler problems

I tried compiling doxygen only with Sun's C++ WorkShop Compiler version 5.0 (I used ./configure --platform solaris-cc)

Qt-2.x.y is required for this compiler (Qt-1.44 has problems with the bool type).

Compiling the doxygen binary went ok, but while linking doxytag I got a lot of link errors, like these:

QList<PageInfo>::__vtbl   /home/dimitri/doxygen/
objects/SunWS_cache/CC_obj_6/6c3eO4IogMT2vrlGCQUQ.o
[Hint: try checking whether the first non-inlined, non-pure 
virtual function of class QList<PageInfo> is defined]

These are generated because the compiler is confused about the object sharing between doxygen and doxytag. To compile doxytag and doxysearch anyway do:

rm -rf objects
mkdir objects
cd src
gmake -f Makefile.doxytag
gmake -f Makefile.doxysearch

when configuring with --static I got:

Undefined                       first referenced
 symbol                             in file
dlclose                             /usr/lib/libc.a(nss_deffinder.o)
dlsym                               /usr/lib/libc.a(nss_deffinder.o)
dlopen                              /usr/lib/libc.a(nss_deffinder.o)

Manually adding -Bdynamic after the target rule in Makefile.doxygen and Makefile.doxytag will fix this:

$(TARGET): $(OBJECTS) $(OBJMOC) 
        $(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS) -Bdynamic

GNU 2.7.2.x compiler problems

Older versions of the GNU compiler have problems with constant strings containing characters with character codes larger than 127. Therefore the compiler will fail to compile some of the translator_xx.h files. A workaround, if you are planning to use the English translation only, is to configure doxygen with the --english-only option.

On some platforms (such as OpenBSD) using some versions of gcc with -O2 can lead to eating all memory during the compilation of files such as config.cpp. As a workaround use --debug as a configure option or omit the -O2 for the particular files in the Makefile.

Dot problems

Due to a change in the way image maps are generated, older versions of doxygen (<=1.2.17) will not work correctly with newer versions of graphviz (>=1.8.8). The effect of this incompatibility is that generated graphs in HTML are not properly clickable.

Compiling from source on Windows

Currently, I have only compiled doxygen for Windows using Microsoft's Visual C++ (version 6.0). For other compilers you may need to edit the perl script in wintools/make.pl a bit. Let me know what you had to change if you got Doxygen working with another compiler.

Since Windows comes without all the nice tools that Unix users are used to, you need to install a number of these tools before you can compile doxygen for Windows.

Here is what is required:

Compilation is now done by performing the following steps:

  1. Open a dos box. Make sure all tools (i.e. nmake, latex, gswin32, dvips, sed, flex, bison, cl, rm, and perl), are accessible from the command-line (add them to the PATH environment variable if needed).

    Notice: The use of LaTeX is optional and only needed for compilation of the documentation into PostScript or PDF. It is not needed for compiling the doxygen's binaries.

  2. Go to the doxygen root dir and type:

        make.bat msvc
    

    This should build the executables doxygen.exe, doxytag.exe, and doxysearch.exe using Microsoft's Visual C++ compiler (The compiler should not produce any serious warnings or errors).

    You can use also the bcc argument to build executables using the Borland C++ compiler, or mingw argument to compile using GNU gcc.

  3. To build the examples, go to the examples subdirectory and type:

        nmake
    

  4. To generate the doxygen documentation, go to the doc subdirectory and type:

        nmake
    

    The generated HTML docs are located in the ..\html subdirectory.

    The sources for LaTeX documentation are located in the ..\latex subdirectory. From those sources, the DVI, PostScript, and PDF documentation can be generated.

Installating the binaries on Windows

There is no fancy installation procedure at the moment (if anyone can add it in a location independent way please let me know).

To install doxygen, just copy the binaries from the bin directory to a location somewhere in the path. Alternatively, you can include the bin directory of the distribution to the path.

Tools used to develop doxygen

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

Go to the next section or return to the index.


Generated on Wed Mar 5 09:19:28 2003 for Doxygen manual by doxygen1.2.18