X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=doc%2Fctsim-install.tex;h=b0cd92fbb449e5831d98c0bc0428fad5bf1ca2fd;hp=74fedcb3468ec9d4f5e005d8e65f397c87a88a5e;hb=b161e504433ad5d62dd2ecb0e325da73718f00a3;hpb=cc68f60c280df39d8cd14dfde3c1f5b736ede026 diff --git a/doc/ctsim-install.tex b/doc/ctsim-install.tex index 74fedcb..b0cd92f 100644 --- a/doc/ctsim-install.tex +++ b/doc/ctsim-install.tex @@ -1,49 +1,69 @@ -\chapter{Installation}\index{Installation}% -\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% -\setfooter{\thepage}{}{}{}{}{\thepage}% +\chapter{Installation}\label{installation}\index{Installation}% +\setheader{{\it CHAPTER \thechapter}}{}{}{\ctsimheadtitle}{}{{\it CHAPTER \thechapter}}% +\ctsimfooter% -\section{Download}\label{download}\index{Installation,Download}% +\section{Download}\label{download}\index{Download}% -The latest version of \ctsim, plus source code, can be accessed from: +The latest version of \ctsim, both as executable programs and source code, + can be downloaded from the official + \ctsim\ \urlref{web site}{http://www.ctsim.org}. Additionally, these + files are also available from the \ctsim\ \urlref{FTP site}{ftp://ftp.ctsim.org}. -\begin{verbatim} -http://www.ctsim.org -ftp://ftp.ctsim.org -\end{verbatim} -It is available in Windows 95/NT/2000 and Linux GUI versions and non-GUI versions. +\section{Installing Windows Binary} -\section{Installing Linux RPM}\index{Installation,Linux}% +Download the Windows executable file. +Simply execute this program to begin the +installation program. \ctsim\ will then be accessible from the +\texttt{Start} Menu under the \texttt{Programs} submenu. -\section{Installing Windows Binary}\index{Installation,Windows}% +\ctsim\ is compatible with Windows 98, Windows Me, Windows NT 4.0, +and Windows 2000. Due to use of the OpenGL and htmlhelp libraries, +\ctsim\ is not compatible with the stock Windows 95 system. -\section{Build From Sources}\label{build}\index{Installation,Build}% +\section{Installing Linux RPM} +Download the \ctsim\ RPM file, then use +the \texttt{rpm} manager program as follows:\\ +\hspace*{1cm}\texttt{rpm -Uvh} \emph{ctsim-*.rpm}\\ -See the INSTALL file included in the source distribution for instructions. +\ctsim\ and \ctsimtext\ will then be installed in the \texttt{/usr/local/bin} +directory. The online help file, \texttt{ctsim.hhp}, will be installed in +directory \texttt{/usr/local/man}. -\section{Web Requirements}\label{installreq}\index{Installation,Requirements}% - \begin{itemize}\itemsep=0pt - \item zlib Library (optional) - \par Used for PNG file export. +\section{Build From Sources}\label{build}\index{Source code build} - \item libpng Library (optional) - \par Used for PNG file export. - \par www.libpng.org +Refer to the INSTALL file included in the source distribution for +instructions. - \item FFTW library (optional) - \par Used for frequency-based filtering and fourier transformations of images. - \par www.fftw.org +\subsection{Optional Libraries} +These libraries are optional and not required to build \ctsim\ from source code. +However, they add functionality to \ctsim\ and there inclusion is recommended. - \item readline library (optional) - \par Used for \ctsimtext interactive shell. + \begin{itemize} + \item \textbf{wxWindows}\\ + Used for the platform-independent graphical interface. The graphical version + of \ctsim\ requires this library.\\ + \urlref{Web site}{http://www.wxwindows.org} - \item dmalloc library (optional) - \par Used for debugging memory allocation - \par www.dmalloc.com + \item \textbf{FFTW}\\ + Used for fast Fourier transformations of projections and images. + Without this library \ctsim\ will use slower, traditional Fourier transformations.\\ + \urlref{Web site}{http://www.fftw.org} - \item wxWindows library (optional) - \par Used for platform-independent graphical interface. The graphical-shell - program \ctsim\ requires this library. - \par www.wxwindows.org -\end{itemize} + \item \textbf{libpng}\\ + Used for PNG file export.\\ + \urlref{Web site}{http://www.libpng.org/pub/png/libpng.html} + + \item \textbf{zlib}\\ + Used for PNG file export.\\ + \urlref{Web site}{http://www.info-zip.org/pub/infozip/zlib/zlib_docs.html} + + \item \textbf{readline}\\ + Used for \ctsimtext\ interactive shell.\\ + \urlref{Web site}{http://www.gnu.org} + \item \textbf{dmalloc}\\ + Used for debugging memory allocation.\\ + \urlref{Web site}{http://www.dmalloc.com} + +\end{itemize}