/****************************************************************************** * * * * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /*! \page install Installation \addindex installation \tableofcontents{html,latex} First go to the download page to get the latest distribution, if you have not downloaded doxygen already. \section install_src_unix Compiling from source on UNIX If you downloaded the source distribution, you need at least the following to build the executable:
GNU make
, and \c strip
\addindex flex
\addindex bison
\addindex libiconv
\addindex make
\addindex strip
\addindex python
cmake
tries to determine the platform you use, and will look
for the requires tools. It will report if something is missing.
If you have Qt-4.3 or higher installed and want to build the GUI
front-end, you should enable it as follows:
cmake -Dbuild_wizard=YES ..
For an overview of other configuration options use
cmake -L ..
doxygen
and optionally doxywizard
)
should be available in the bin directory within the build directory.
index.html
in the html directory).
make install
to install doxygen. If you downloaded the binary distribution for Linux,
type:
make install
Binaries are installed into the directory /usr/local/bin
,
man pages in /usr/local/man/man1
and documentation in
/usr/local/doc/doxygen
To change this just edit the Makefile.
\note You need the GNU install tool for this to work (it is part of
the coreutils 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.
\section install_src_windows Compiling from source on Windows
From version 1.8.10 onwards, build files need to be generated by cmake.
cmake can be downloaded from https://cmake.org/download/
\addindex cmake
At the moment only the express version of Visual Studio 2013 is tested,
but other version might also work.
Alternatively, you can compile doxygen
\ref install_src_unix "the UNIX way" using
Cygwin
or MinGW.
\addindex flex
\addindex bison
The next step is to install modern versions of \c bison and \c flex
(see https://sourceforge.net/projects/winflexbison/. After installation and adding them to
your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`)
\addindex python
Furthermore you have to install \c python (version 2.6 or higher, see https://www.python.org).
These packages are needed during the compilation process.
Download doxygen's source tarball and put it somewhere (e.g. use c:\\tools
)
Now start a visual studio native command shell (for either x86 or x64) and type
\verbatim
cd c:\tools
tar zxvf doxygen-x.y.z.src.tar.gz
\endverbatim
to unpack the sources (you can obtain \c tar from e.g. http://gnuwin32.sourceforge.net/packages.html).
Alternatively you can use an unpack program, like 7-Zip (see https://www.7-zip.org/)
or use the built-in unpack feature of modern Windows systems).
Now your environment is setup to generate the required project files for \c doxygen.
cd into the \c doxygen-x.y.z directory, create and cd to a build directory
\verbatim
mkdir build
cd build
cmake -G "Visual Studio 12 2013" ..
\endverbatim
Note that compiling Doxywizard requires Qt 4.3 or newer
(see https://www.qt.io/developers/).
Also read the next section for additional tools you may need to install to run
doxygen with certain features enabled.
\section install_bin_windows Installing the binaries on Windows
Doxygen comes as a self-installing archive, so installation is extremely simple.
Just follow the dialogs.
After installation it is recommended to also download and install GraphViz
(version 2.20 or better is highly recommended). Doxygen can use the \c dot tool
of the GraphViz package to render nicer diagrams, see the
\ref cfg_have_dot "HAVE_DOT" option in the configuration file.
If you want to produce compressed HTML files (see \ref
cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the configuration file, then
you need the Microsoft HTML help workshop.
You can download it from
Microsoft.
If you want to produce Qt Compressed Help files (see \ref
cfg_qhg_location "QHG_LOCATION") in the configuration file, then
you need qhelpgenerator which is part of Qt.
You can download Qt from Qt Software Downloads.
In order to generate PDF output or use scientific formulas you will also need to
install LaTeX and
Ghostscript.
For \LaTeX a number of distributions exists. Popular ones that should work with
doxygen are MikTex
and proTeXt.
Ghostscript can be downloaded
from Sourceforge.
After installing \LaTeX and Ghostscript you'll need to make sure the tools
latex.exe, pdflatex.exe, and gswin32c.exe (or gswin64c.exe) are present in the search path of a
command box. Follow these
instructions if you are unsure and run the commands from a command box to verify it works.
\htmlonly
Go to the next section or return to the
index.
\endhtmlonly
*/