songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix typos 

libCGALFoo -> libCGAL\_Foo to be consistent
This commit is contained in:
Sébastien Loriot 2012-05-25 12:29:25 +00:00
parent 41d3549414
commit 73f1d7ea35
2 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Installation/doc_tex/Installation/installation.tex
View File

@ -409,7 +409,7 @@ see \ref{sec:3partysoftwareconfig} to specify the location of 3rd
party software.
The libraries \stl\ (shipped with any compiler) and \boost\ are essential to all components (i.e.~libCGAL,
libCGALCore, libCGALimageIO, libCGALQt3 and libCGALQt4):
libCGAL\_Core, libCGAL\_imageIO, libCGAL\_Qt3 and libCGAL\_Qt4):
%\subsection{Standard Template Library (\stl) \label{thirdparty:stl}}
%
@ -449,7 +449,7 @@ to where you have installed \boost, e.g., \path|C:\boost\boost_1_41_0|.
\subsection{\gmp\ and \mpfr\ \label{thirdparty:GMP} \label{thirdparty:MPFR}}
The components libCGAL, libCGALCore, libCGALQt3 and libCGALQt4 require
The components libCGAL, libCGAL\_Core, libCGAL\_Qt3 and libCGAL\_Qt4 require
\gmp\ and \mpfr\ which are libraries for multi precision integers and rational numbers,
and for multi precision floating point numbers.
@ -469,7 +469,7 @@ of \gmp\ and \mpfr, which can be downloaded with the installer
\subsection{\zlib \label{thirdparty:zlib}}
\zlib\ is a data compression library, and is essential for the component libCGALimageIO.
\zlib\ is a data compression library, and is essential for the component libCGAL\_imageIO.
In \cgal\ this library is used in the examples of the \ccRef[Surface Mesh Generation]{Pkg:SurfaceMesher3} package.
@ -481,8 +481,8 @@ for instance, on Windows, you can download it from \zlibpage.
\opengl\ (Open Graphics Library) provides an API for applications that
produce 2D and 3D computer graphics.
In \cgal\ the library is essential for the components libCGALQt3 and
libCGALQt4, as well as libCGALimagIO and for various demos.
In \cgal\ the library is essential for the components libCGAL\_Qt3 and
libCGAL\_Qt4, as well as libCGAL\_imageIO and for various demos.
Typically, \opengl\ is preinstalled on systems; if not, it can be
downloaded from \openglpage.
@ -491,13 +491,13 @@ downloaded from \openglpage.
Qt is a cross-platform application and UI framework.
The component libCGALQt3 requires \qt3\ installed on your system, while
the component libCGALQt4 requires \qt4\ installed on your system.
The component libCGAL\_Qt3 requires \qt3\ installed on your system, while
the component libCGAL\_Qt4 requires \qt4\ installed on your system.
In case \qt\ is not yet installed on your system, you can download
it from \qtpage.
Older demos of \cgal use libCGALQt3 and \qt3, while newer and newly
developed demos require libCGALQt4 and \qt4.
Older demos of \cgal use libCGAL\_Qt3 and \qt3, while newer and newly
developed demos require libCGAL\_Qt4 and \qt4.
Having \qt4\ version 4.3.0 or higher is recommended.
@ -520,7 +520,7 @@ demos shipped with \cgal\ or to build your own project using \cgal. In order
to simplify these builds, various libraries can be \emph{prepared to be
used with \cgal} while configuring \cgal, just in the same way as
essential libraries are configured. Whenever building an example or a
demo (or youw own executable), these \emph{preconfigured} libraries
demo (or your own executable), these \emph{preconfigured} libraries
are available with using \cgal.
% EBEB: I removed CORE. We actually do not encourage at this point to
@ -1394,7 +1394,7 @@ and \cmake\ searches for most of them.
If they are not found, you can indicate the directory containing the libraries, or provide a
semi-colon separated list of pathnames to the libraries which collectively implement the functions.
Many of the libraries implementing \blas\ and \lapack\ require the \ftoc\ library for Fortran-to-C convertion.
Many of the libraries implementing \blas\ and \lapack\ require the \ftoc\ library for Fortran-to-C conversion.
If this is needed and not found, you may specify the fullpath of the library in the \texttt{F2C\_LIBRARIES}
variable. You do not need to provide this, if the \blas\ \lapack\ libraries do not need \ftoc.
@ -1434,7 +1434,7 @@ the header files and the full pathnames of the release and debug libraries
\gdef\lcTabularBorder{2}
\begin{tabular}{|l|l|l|} \hline
\textbf{Variable} & \textbf{Description} & \textbf{Type}\\\hline\hline
\texttt{QGLVIEWERROOT} & Root directory of the QGViewer library & Environment\\\hline
\texttt{QGLVIEWERROOT} & Root directory of the QGLViewer library & Environment\\\hline
\texttt{QGLVIEWER\_INCLUDE\_DIR} & Directory containing the \texttt{QGLViewer/qglviewer.h} file & CMake\\\hline
\texttt{QGLVIEWER\_LIBRARY\_RELEASE} & Full pathname to a release build of the QGLViewer library & CMake\\\hline
\texttt{QGLVIEWER\_LIBRARY\_DEBUG} & Full pathname to a debug build of the QGLViewer library & CMake\\\hline

14
Installation/doc_tex/Installation/usage.tex
View File

@ -1,7 +1,7 @@
\section{Configuring and Building Programs Using \cgal}
Ideally, comfiguring and compiling a demo/example/program amounts to
Ideally, configuring and compiling a demo/example/program amounts to
{\ccTexHtml{}{}
\begin{alltt}
@ -23,7 +23,7 @@ required \texttt{CMakeLists.txt} is already provided.
\texttt{CMakeLists.txt} script either manually, or with the help of a
shell-script that is introduced below.
For a user program \texttt{exetutable.cpp}, the ideal world looks like this:
For a user program \texttt{executable.cpp}, the ideal world looks like this:
{\ccTexHtml{}{}
\begin{alltt}
@ -110,17 +110,17 @@ is contained in the
\texttt{cgal\_create\_cmake\_script} in an application directory creates a
\texttt{CMakeLists.txt} containing rules for every \texttt{*.cpp} file
there. The script is deprecated, as it only works for applications
with a single course file that only need libCGAL and libCGALCore.
with a single course file that only need libCGAL and libCGAL\_Core.
\end{ccDeprecated}
Such a shell-script simply creates a \cmake\ script. Processing it
with \cmnke, searches for \cgal\ using \texttt{find\_package}. If found,
with \cmake, searches for \cgal\ using \texttt{find\_package}. If found,
the variable \texttt{CGAL\_USE\_FILE} is set to a compilation environment \cmake\ file. Including
this file within a \cmake\ script sets up include paths and libraries to
link with of \cgal\ and essential third party libraries. Beyond,
link with \cgal\ and essential third party libraries. Beyond,
\texttt{find\_package} can demand for \texttt{COMPONENTS} of \cgal,
that is, all \cgal\ libaries libCGALCore (``Core''),
libCGALimageIO (``ImageIO'') , libCGALQt3 (``Qt3'') and libCGALQt4
that is, all \cgal\ libraries libCGAL\_Core (``Core''),
libCGAL\_imageIO (``ImageIO'') , libCGAL\_Qt3 (``Qt3'') and libCGAL\_Qt4
(``Qt4'') or optional 3rd party software such as ``MPFI'', ``RS3'' or
``LAPACK''. A user is free to create the \texttt{CMakeLists.txt}
without calling the script (manual creation).