7c283a4cfc4dbaf786544cb5bf7e6b879adae6bb
[ctsim.git] / doc / ctsim-install.tex
1 \chapter{Installation}\label{installation}\index{Installation}%
2 \setheader{{\it CHAPTER \thechapter}}{}{}{\ctsimheadtitle}{}{{\it CHAPTER \thechapter}}%
3 \ctsimfooter%
4
5 \section{Download}\label{download}\index{Download}%
6
7 The latest version of \ctsim, both executable programs and source code,
8  can be downloaded from the official
9  \ctsim\ \urlref{web site}{http://www.ctsim.org}. Additionally, these
10  files are also available from the \urlref{FTP site}{ftp://ftp.ctsim.org}.
11
12
13 \section{Installing Windows Binary}
14
15 Download the Windows executable file.
16 Simply execute this program to unpack \ctsim\ and begin the
17 installation program. \ctsim\ will then be accessible from the
18 \texttt{Start} Menu under the \texttt{Programs} submenu.
19
20 \ctsim\ is compatible with Windows 98, Windows Me, Windows NT 4.0,
21 and Windows 2000. Due to use of the OpenGL and htmlhelp libraries,
22 \ctsim\ is not compatible with the stock Windows 95 system.
23
24 \section{Installing Linux RPM}
25 Download the RPM file, then use
26 the \texttt{rpm} manager program:\\
27 \hspace{1cm}\texttt{rpm -Uvh} \emph{ctsim-*.rpm}\\
28
29 \ctsim\ and \ctsimtext\ will then be installed in the \texttt{/usr/local/bin}
30 directory. The online help file, \texttt{ctsim.hhp}, will be installed in
31 directory \texttt{/usr/local/man}.
32
33 \section{Build From Sources}\label{build}\index{Build}
34
35 Refer to the INSTALL file included in the source distribution for
36 instructions.
37
38 \subsection{Optional Libraries}%
39   \begin{itemize}
40   \item \textbf{wxWindows}\\
41   Used for platform-independent graphical interface. The graphical version
42   of \ctsim\ requires this library.\\
43   \urlref{Web site}{http://www.wxwindows.org}
44
45   \item \textbf{FFTW}\\
46     Used for fast frequency-based filtering and fourier transformations of images.
47     Without this library \ctsim\ will use slower, traditional Fourier transformations.\\
48     \urlref{Web site}{http://www.fftw.org}
49
50   \item \textbf{libpng}\\
51         Used for PNG file export.\\
52     \urlref{Web site}{http://www.libpng.org/pub/png/libpng.html}
53
54   \item \textbf{zlib}\\
55         Used for PNG file export.\\
56     \urlref{Web site}{http://www.info-zip.org/pub/infozip/zlib/zlib_docs.html}
57
58   \item \textbf{readline}\\
59     Used for \ctsimtext\ interactive shell.\\
60     \urlref{Web site}{http://www.gnu.org}
61
62   \item \textbf{dmalloc}\\
63     Used for debugging memory allocation\\
64     \urlref{Web site}{http://www.dmalloc.com}
65
66 \end{itemize}