VES5.0/doxygen-1.8.12/html/install.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Doxygen: Installation</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="doxygen_manual.css" rel="stylesheet" type="text/css" />
  20 </head>
  21 <body>
  22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23 <div id="titlearea">
  24 <table cellspacing="0" cellpadding="0">
  25  <tbody>
  26  <tr style="height: 56px;">
  27   <td id="projectalign" style="padding-left: 0.5em;">
  28    <div id="projectname">Doxygen
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.12 -->
  37 </div><!-- top -->
  38 <div id="side-nav" class="ui-resizable side-nav-resizable">
  39   <div id="nav-tree">
  40     <div id="nav-tree-contents">
  41       <div id="nav-sync" class="sync"></div>
  42     </div>
  43   </div>
  44   <div id="splitbar" style="-moz-user-select:none;"
  45        class="ui-resizable-handle">
  46   </div>
  47 </div>
  48 <script type="text/javascript">
  49 $(document).ready(function(){initNavTree('install.html','');});
  50 </script>
  51 <div id="doc-content">
  52 <div class="header">
  53   <div class="headertitle">
  54 <div class="title">Installation </div>  </div>
  55 </div><!--header-->
  56 <div class="contents">
  57 <div class="toc"><h3>Table of Contents</h3>
  58 <ul><li class="level1"><a href="#install_src_unix">Compiling from source on UNIX</a></li>
  59 <li class="level1"><a href="#install_bin_unix">Installing the binaries on UNIX</a></li>
  60 <li class="level1"><a href="#install_src_windows">Compiling from source on Windows</a></li>
  61 <li class="level1"><a href="#install_bin_windows">Installing the binaries on Windows</a></li>
  62 </ul>
  63 </div>
  64 <div class="textblock"><p><a name="ainstallation"></a></p>
  65 <p>First go to the <a href="http://www.doxygen.org/download.html">download</a> page to get the latest distribution, if you have not downloaded doxygen already.</p>
  66 <h1><a class="anchor" id="install_src_unix"></a>
  67 Compiling from source on UNIX</h1>
  68 <p>If you downloaded the source distribution, you need at least the following to build the executable: </p><ul>
  69 <li>
  70 The <a href="ftp://prep.ai.mit.edu/pub/gnu/">GNU</a> tools <code>flex</code>, <code>bison</code>, <code>libiconv</code> and <code>GNU make</code>, and <code>strip</code> <a name="aflex"></a> <a name="abison"></a> <a name="alibiconv"></a> <a name="amake"></a> <a name="astrip"></a> <a name="apython"></a> </li>
  71 <li>
  72 In order to generate a <code>Makefile</code> for your platform, you need <a href="http://www.cmake.org/">cmake</a> version 2.8.12 or later. <a name="acmake"></a> </li>
  73 </ul>
  74 <p>To take full advantage of doxygen's features the following additional tools should be installed.</p>
  75 <ul>
  76 <li>
  77 Qt Software's GUI toolkit <a href="http://qt-project.org/">Qt</a> <a name="aQt"></a> version 4.3 or higher (but currently, Qt 5.x is not yet supported). This is needed to build the GUI front-end doxywizard. </li>
  78 <li>
  79 A <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> distribution: for instance <a href="http://www.tug.org/interest.html#free">TeX Live</a> This is needed for generating <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/>, Postscript, and PDF output. </li>
  80 <li>
  81 <a href="http://www.graphviz.org/">the Graph visualization toolkit version 1.8.10 or higher</a> Needed for the include dependency graphs, the graphical inheritance graphs, and the collaboration graphs. If you compile graphviz yourself, make sure you do include freetype support (which requires the freetype library and header files), otherwise the graphs will not render proper text labels. </li>
  82 <li>
  83 For formulas in the HTML output (when MathJax is not used) or in case you do not wish to use `pdflatex, the ghostscript interpreter is needed. You can find it at <a href="http://www.ghostscript.com/">www.ghostscript.com</a>. </li>
  84 </ul>
  85 <p>Compilation is now done by performing the following steps:</p>
  86 <ol>
  87 <li>
  88 <p class="startli">Unpack the archive, unless you already have done that: </p><pre class="fragment">gunzip doxygen-$VERSION.src.tar.gz    # uncompress the archive
  89 tar xf doxygen-$VERSION.src.tar       # unpack it
  90 </pre><p class="endli"></p>
  91 </li>
  92 <li>
  93 <p class="startli">Create a build directory (for instance inside the source tree) </p><pre class="fragment">cd doxygen-$VERSION
  94 mkdir build
  95 </pre><p> cd build</p>
  96 <p class="endli"></p>
  97 </li>
  98 <li>
  99 <p class="startli">Run cmake with the makefile generator </p><pre class="fragment">cmake -G "Unix Makefiles" ..
 100 </pre><p><code>cmake</code> tries to determine the platform you use, and will look for the requires tools. It will report if something is missing.</p>
 101 <p>If you have Qt-4.3 or higher installed and want to build the GUI front-end, you should enable it as follows: </p><pre class="fragment">cmake -Dbuild_wizard=YES ..
 102 </pre><p>For an overview of other configuration options use </p><pre class="fragment">cmake -L ..
 103 </pre><p class="endli"></p>
 104 </li>
 105 <li>
 106 <p class="startli">Compile the program by running make: </p><pre class="fragment">make
 107 </pre><p>The program should compile without problems and the binaries (<code>doxygen</code> and optionally <code>doxywizard</code>) should be available in the bin directory within the build directory.</p>
 108 <p class="endli"></p>
 109 </li>
 110 <li>
 111 <p class="startli">Optional: Generate the user manual. </p><pre class="fragment">cmake -Dbuild_doc=YES ..
 112 make docs
 113 </pre><p>To let doxygen generate the HTML and PDF documentation.</p>
 114 <p>The HTML directory within the build directory will now contain the html documentation (just point a HTML browser to the file <code>index.html</code> in the html directory).</p>
 115 <p class="endli"></p>
 116 </li>
 117 </ol>
 118 <h1><a class="anchor" id="install_bin_unix"></a>
 119 Installing the binaries on UNIX</h1>
 120 <p>After the compilation of the source code do a <code>make install</code> to install doxygen. If you downloaded the binary distribution for UNIX, type: </p><pre class="fragment">./configure
 121 make install
 122 </pre><p>Binaries are installed into the directory <code>&lt;prefix&gt;/bin</code>. Use <code>make install_docs</code> to install the documentation and examples into <code>&lt;docdir&gt;/doxygen</code>.</p>
 123 <p><code>&lt;prefix&gt;</code> defaults to <code>/usr/local</code> but can be changed with the <code>--prefix</code> option of the configure script. The default <code>&lt;docdir&gt;</code> directory is <code>&lt;prefix&gt;/share/doc/packages</code> and can be changed with the <code>--docdir</code> option of the configure script.</p>
 124 <p>Alternatively, you can also copy the binaries from the <code>bin</code> directory manually to some <code>bin</code> directory in your search path. This is sufficient to use doxygen.</p>
 125 <dl class="section note"><dt>Note</dt><dd>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!</dd></dl>
 126 <p>If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages.</p>
 127 <h1><a class="anchor" id="install_src_windows"></a>
 128 Compiling from source on Windows</h1>
 129 <p>From version 1.8.10 onwards, build files need to be generated by cmake. cmake can be downloaded from <a href="http://www.cmake.org/download/">http://www.cmake.org/download/</a></p>
 130 <p>At the moment only the express version of Visual Studio 2013 is tested, but other version might also work.</p>
 131 <p>Alternatively, you can compile doxygen <a class="el" href="install.html#install_src_unix">the UNIX way</a> using <a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a> or <a href="http://www.mingw.org/">MinGW</a>.</p>
 132 <p>The next step is to install modern versions of <code>bison</code> and <code>flex</code> (see <a href="http://sourceforge.net/projects/winflexbison">http://sourceforge.net/projects/winflexbison</a>. After installation and adding them to your <code>path</code> rename <code>win_flex.exe</code> to <code>flex.exe</code> and <code>win_bison.exe</code> to <code>bison.exe</code>) Furthermore you have to install <code>python</code> (version 2.6 or higher, see <a href="http://www.python.org">http://www.python.org</a>). These packages are needed during the compilation process.</p>
 133 <p>Download doxygen's source tarball and put it somewhere (e.g. use <code>c:\tools</code>)</p>
 134 <p>Now start a visual studio native command shell (for either x86 or x64) and type </p><pre class="fragment">cd c:\tools
 135 tar zxvf doxygen-x.y.z.src.tar.gz
 136 </pre><p> to unpack the sources (you can obtain <code>tar</code> from e.g. <a href="http://gnuwin32.sourceforge.net/packages.html">http://gnuwin32.sourceforge.net/packages.html</a>). Alternatively you can use an unpack program, like 7-Zip (see <a href="http://www.7-zip.org">http://www.7-zip.org</a>) or use the build in unpack feature of modern Windows systems).</p>
 137 <p>Now your environment is setup to generate the required project files for <code>doxygen</code>.</p>
 138 <p>cd into the <code>doxygen-x.y.z</code> directory, create and cd to a build directory </p><pre class="fragment">mkdir build
 139 cd build
 140 cmake -G "Visual Studio 12 2013" ..
 141 </pre><p>Note that compiling Doxywizard currently requires Qt version 4 (see <a href="http://qt-project.org/">http://qt-project.org/</a>).</p>
 142 <p>Also read the next section for additional tools you may need to install to run doxygen with certain features enabled.</p>
 143 <h1><a class="anchor" id="install_bin_windows"></a>
 144 Installing the binaries on Windows</h1>
 145 <p>Doxygen comes as a self-installing archive, so installation is extremely simple. Just follow the dialogs.</p>
 146 <p>After installation it is recommended to also download and install GraphViz (version 2.20 or better is highly recommended). Doxygen can use the <code>dot</code> tool of the GraphViz package to render nicer diagrams, see the <a class="el" href="config.html#cfg_have_dot">HAVE_DOT</a> option in the configuration file.</p>
 147 <p>If you want to produce compressed HTML files (see <a class="el" href="config.html#cfg_generate_htmlhelp">GENERATE_HTMLHELP</a>) in the config file, then you need the Microsoft HTML help workshop. You can download it from <a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138">Microsoft</a>.</p>
 148 <p>If you want to produce Qt Compressed Help files (see <a class="el" href="config.html#cfg_qhg_location">QHG_LOCATION</a>) in the config file, then you need qhelpgenerator which is part of Qt. You can download Qt from <a href="http://qt-project.org/downloads">Qt Software Downloads</a>.</p>
 149 <p>In order to generate PDF output or use scientific formulas you will also need to install <a href="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and <a href="http://en.wikipedia.org/wiki/Ghostscript">Ghostscript</a>.</p>
 150 <p>For <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> a number of distributions exists. Popular ones that should work with doxygen are <a href="http://www.miktex.org">MikTex</a> and <a href="http://www.tug.org/protext/">proTeXt</a>.</p>
 151 <p>Ghostscript can be <a href="http://sourceforge.net/projects/ghostscript/">downloaded</a> from Sourceforge.</p>
 152 <p>After installing <img class="formulaInl" alt="$\mbox{\LaTeX}$" src="form_0.png"/> and Ghostscript you'll need to make sure the tools latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a command box. Follow <a href="http://www.computerhope.com/issues/ch000549.htm">these</a> instructions if you are unsure and run the commands from a command box to verify it works.</p>
 153 <p>
 154 Go to the <a href="starting.html">next</a> section or return to the
 155  <a href="index.html">index</a>.
 156  </p>
 157 </div></div><!-- contents -->
 158 </div><!-- doc-content -->
 159 <!-- start footer part -->
 160 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 161   <ul>
 162     <li class="footer">Generated by
 163     <a href="http://www.doxygen.org/index.html">
 164     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
 165   </ul>
 166 </div>
 167 </body>
 168 </html>