]> Creatis software - gdcm.git/blobdiff - Doc/DoxyInstallation.txt
ENH: Fix a shadow variable
[gdcm.git] / Doc / DoxyInstallation.txt
index 3ba3bacac64ba34295c4642088d9e9ca8acc2c90..95a80569a0e51a04a3d0ff0fb2cde8171e16d863 100644 (file)
@@ -2,10 +2,10 @@
  * \page DoxyInstallation Installing gdcm and gdcmPython
  * \section DoxyRequirements Requirements
  *  - For the core C++ library you shall need a C++ compiler with the
- *    <list> and <map> STL containers. Gdcm is developped and tested under:
+ *    "list" and "map" STL containers. Gdcm is developped and tested under:
  *    -# GNU/linux (gcc 2.96.x)
  *    -# Win32/VC++ 6.x
- *     .
+ *  .
  *  - For \ref DoxyPythonComplete you shall need:
  *    -# <A HREF="http://www.python.org/2.2.2/">Python version 2.2.x</A>
  *    -# <A HREF="http://www.swig.org">Swig</A> version >= 1.3.17x (in order
  *             <A HREF="http://www.swig.org/download.html">the sources</A>
  *       </UL>
  *       \endhtmlonly
- *     .
+ *    .
  *  .
- * 
- * \section DoxyInstallLinux Linux
+ *
+ * \section DoxyInstallLinux Un*x
  * \subsection DoxyInstallLinuxCvs Starting from cvs sources.
- *     - Retrieve the sources through cvs
- *     - <TT>cd gdcm</TT>
- *     - <TT>./autogen.sh --help</TT> in order to select your preferences
- *     - <TT>./autogen.sh</TT> to launch the usual automake/autoconf
+ *  - Retrieve the
+ *      <A HREF="http://www.creatis.insa-lyon.fr/Public/Gdcm/cvs.html">
+ *        sources through cvs</A>,
+ *  - <TT>cd gdcm</TT>
+ *  - <TT>./autogen.sh --help</TT> in order to select your preferences
+ *  - <TT>./autogen.sh</TT> to launch the usual automake/autoconf
  *       process e.g.
- *       -# <TT>./autogen.sh --prefix=/where/ever/you/want</TT>
- *           to configure the script to force installation in a specified
- *            place.
- *       -# <TT>./autogen.sh --enable-python</TT> to generate the
- *              python wrappers.
- *        .
- *     - <TT>make</TT> (or <TT>make 'CFLAGS=-g</TT>...)
- *     - <TT>make instal</TT>
- *     - As usual, you can optionnally:
- *       -# <TT>make clean</TT>
- *       -# <TT>make 'CFLAGS='</TT> if you are in hurry and want to omit
- *          "-g -O2" default flags
- *       -# <TT>make snapshot</TT>
- *        .
- *     .
+ *    -# <TT>./autogen.sh --prefix=/where/ever/you/want</TT>
+ *              to configure the script to force installation in a specified
+ *              place.
+ *    -# <TT>./autogen.sh --enable-python</TT> to generate the
+ *              python wrappers (a.k.a. gdcmPython)
+ *    -# <TT>./autogen.sh --enable-vtk</TT> to generate the
+ *              vtk clases that shallow wrap gdcm,
+ *    -# <TT>./autogen.sh --enable-doxygen</TT> to generate the
+ *              <A HREF="http://www.doxygen.org/">doxygen</A>
+ *              based documentation
+ *    .
+ *  .
+ *  - <TT>make</TT>
+ *  - <TT>make instal</TT>
+ *  - As usual, you can optionnally:
+ *    -# <TT>make clean</TT>
+ *    -# <TT>make CFLAGS='-g' CXXFLAGS='-DPUB_DICT_PATH=\"/usr/local/share/gdcm/\" -D__STDC_LIMIT_MACROS'</TT>
+ *        if you are in hurry and want to omit "-g -O2" default flags
+ *    -# <TT>make snapshot</TT>
+ *  .
+ *
  * \subsection DoxyInstallLinuxSources Starting from the sources (snapshot).
  *     The process is exactly the same as the one using the cvs sources
  *     (see above) except that you shall use <TT>./configure</TT> instead