diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex index f408f5c452d9c6c8f5fba22d05643e8e46d64e89..7986e62ec9fceb2cdb808e32cfef6dd855e59247 100644 --- a/doc/handbook/0_dumux-handbook.tex +++ b/doc/handbook/0_dumux-handbook.tex @@ -8,7 +8,6 @@ \usepackage{amsfonts} \usepackage{amssymb} \usepackage{booktabs} -\usepackage{breakurl} \usepackage{enumerate} \usepackage{hyperref} \usepackage{graphicx} @@ -154,7 +153,6 @@ in deeper modifications of underlying \Dumux models, classes, functions, etc. \input{5_fluidframework} \input{5_grids} - \bibliographystyle{plain} \bibliography{dumux-handbook} \printindex diff --git a/doc/handbook/2_detailedinstall.tex b/doc/handbook/2_detailedinstall.tex index 07a36b9d4ab6368e19234167594dca4829acfe3f..7879d228c53e7ac108435be8259e30248027085e 100644 --- a/doc/handbook/2_detailedinstall.tex +++ b/doc/handbook/2_detailedinstall.tex @@ -17,7 +17,7 @@ In a technical sense \Dumux is a module of \Dune. Thus, the installation procedure of \Dumux is the same as that of \Dune. Details regarding the installation of \Dune are provided on the \Dune website \cite{DUNE-INST}. If you are interested in more details about the build system that is used, -they can be found in the {\Dune} Buildsystem Howto \cite{DUNE-BS}. +they can be found in the {\Dune} CMake FAQs \cite{DUNE-CMAKE} and CMake's documentation \cite{CMAKE-DOC}. All \Dune modules, including \Dumux, get extracted into a common directory, as it is done in an ordinary \Dune installation. @@ -42,10 +42,9 @@ After extracting the source code for all relevant \Dune modules, including \Dumu by the shell-command \texttt{dunecontrol} which is part of the \Dune build system. \subsection{Prerequisites} \label{sec:prerequisites} -The GNU tool chain of \texttt{g++} and the tools of the GNU build system \cite{GNU-BS}, also known as GNU autotools -(\texttt{autoconf}, \texttt{automake}, \texttt{autogen}, \texttt{libtool}), as well as \texttt{make} -must be available in a recent version. For a list of prerequisite software packages to install,see -\cite{DUNE-WIKI-PREREQUISITE-SOFTWARE}. +A reasonable recent C++ compiler (g++, clang++ or Intels ICC), CMake (version 2.8.6 or newer) and their +dependencies are required. +For a list of prerequisite software packages to install see \cite{DUNE-WIKI-PREREQUISITE-SOFTWARE}. The building of included documentation like this handbook requires \LaTeX{} and auxiliary tools \texttt{bibtex}. One usually chooses a \LaTeX{} distribution like \texttt{texlive} for this purpose. @@ -57,7 +56,7 @@ Extracting them can be done using \texttt{doxygen}, cf. Section \ref{sec:build-d Depending on whether you are going to use external libraries and modules for additional \Dune features, additional software packages may be required. Some hints on that are given in Section \ref{sec:external-modules-libraries}. -Subversion (SVN) and a Git clients must be installed to download modules from Subversion and Git repositories. +Subversion (SVN) and Git clients must be installed to download modules from Subversion and Git repositories. \subsection{Obtaining Source Code for \Dune and \Dumux} As stated above, the \Dumux release and trunk (developer tree) are based on the most recent diff --git a/doc/handbook/2_quickinstall.tex b/doc/handbook/2_quickinstall.tex index ab420eabd2d7becfbda84eb3a6226f5f9e8d8fe9..0e8c4ee294cebaa2cddd305e03e19c763c690547 100644 --- a/doc/handbook/2_quickinstall.tex +++ b/doc/handbook/2_quickinstall.tex @@ -27,8 +27,8 @@ guide can be found in chapter \ref{install} or on the \Dune website \cite{DUNE-I \subsection{Build of \Dune and \Dumux} \label{buildIt} -Building of \Dune and \Dumux is done by the command-line script \texttt{dunecontrol} as described in \Dune Installation Notes \cite{DUNE-INST} -and in much more comprehensive form in the \Dune Buildsystem Howto \cite{DUNE-BS}. +Building of \Dune and \Dumux is done by the command-line script \texttt{dunecontrol} as described in \Dune Installation Notes \cite{DUNE-INST}. +More details about the build-system can be found in the \Dune CMake FAQs \cite{DUNE-CMAKE}. If something fails during the execution of \texttt{dunecontrol} feel free to report it to the \Dune or \Dumux developer mailing list, but also try to include error details. diff --git a/doc/handbook/dumux-handbook.bib b/doc/handbook/dumux-handbook.bib index 5bf825c20b01eb6277e05796928e666d2d69f8bc..a748fd5ec1287dc1ebc12f85e5045268447eba85 100644 --- a/doc/handbook/dumux-handbook.bib +++ b/doc/handbook/dumux-handbook.bib @@ -934,6 +934,11 @@ key = {APACHE-SUBVERSION} } +@MISC{CMAKE-DOC, + title = {{CMake} Documentation: \url{http://www.cmake.org/documentation/}}, + key = {CMAKE} +} + @MISC{DOXYGEN-HP, title = {Doxygen Homepage: \url{http://www.stack.nl/~dimitri/doxygen/}}, key = {DOXYGEN} @@ -949,9 +954,9 @@ key = {DUMUX-DOWNLOAD} } -@MISC{DUNE-BS, - title = {{DUNE} Build System Howto: \url{http://www.dune-project.org/doc/buildsystem/buildsystem.pdf}}, - key = {DUNE-BS} +@MISC{DUNE-CMAKE, + title = {{Building Dune with CMake -- Frequently Asked Questions}: \url{http://www.dune-project.org/doc/buildsystem/cmakefaq.pdf}}, + key = {DUNE-CMAKE} } @MISC{DUNE-DOWNLOAD-GIT, @@ -990,7 +995,7 @@ } @MISC{DUNE-WIKI-PREREQUISITE-SOFTWARE, - title = {{DUNE} user wiki, prerequisite software: + title = {{DUNE} user wiki, prerequisite software packages: \url{http://users.dune-project.org/projects/main-wiki/wiki/Installation_prerequisite_software}}, key = {DUNE-WIKI-PREREQUISITE-SOFTWARE} } @@ -1000,18 +1005,13 @@ key = {FENICS} } -@MISC{GNU-BS, - title = {Wikipedia about GNU build system: \url{http://en.wikipedia.org/wiki/GNU_build_system}}, - key = {WIKIPED-GNU-BS} -} - @MISC{STL-REF-HP, title = {A {STL} Reference: \url{http://www.cplusplus.com/reference/stl/}}, key = {STL} } @MISC{UG-HP, - title = {The {UG} Homepage: \url{http://www.iwr.uni-heidelberg.de/frame/iwrwikiequipment/software/ug}}, + title = {{UG} Homepage: \url{http://www.iwr.uni-heidelberg.de/frame/iwrwikiequipment/software/ug}}, key = {UG} }