r568: no message
[ctsim.git] / doc / ctsim-install.tex
index bb4a942a6d8a17aff5ad6ff55948268decd95feb..b0cd92fbb449e5831d98c0bc0428fad5bf1ca2fd 100644 (file)
@@ -1,20 +1,19 @@
 \chapter{Installation}\label{installation}\index{Installation}%
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
+\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}
 
-\section{Installing Windows Binary}\index{Installation,Windows}%
+\section{Installing Windows Binary}
 
-Download the Windows executable file as helprefn{shown}{download}.
-Simply execute this program to unpack \ctsim\ and begin the
+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.
 
@@ -22,42 +21,49 @@ installation program. \ctsim\ will then be accessible from the
 and Windows 2000. Due to use of the OpenGL and htmlhelp libraries,
 \ctsim\ is not compatible with the stock Windows 95 system.
 
-\section{Installing Linux RPM}\index{Installation,Linux}%
-Download the RPM file from as \helprefn{shown}{download}. Then use
-the \texttt{rpm} manager program:\\
-\hspace{1cm}\texttt{rpm -Uvh} \emph{ctsim-*.rpm}\\
+\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}\\
 
-\ctsim will then be installed in the \texttt{/usr/local/bin}
-directory.
+\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{Build From Sources}\label{build}\index{Installation,Build}%
+\section{Build From Sources}\label{build}\index{Source code build}
 
 Refer to the INSTALL file included in the source distribution for
 instructions.
 
-\subsection{Optional Libraries When Building For Source}%
+\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.
+
   \begin{itemize}
-  \item zlib Library\\
-        Used for PNG file export.
+  \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 libpng Library)\\
-        Used for PNG file export.\\
-    www.libpng.org
+  \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 FFTW library)\\
-    Used for frequency-based filtering and fourier transformations of images.\\
-    www.fftw.org
+  \item \textbf{libpng}\\
+        Used for PNG file export.\\
+    \urlref{Web site}{http://www.libpng.org/pub/png/libpng.html}
 
-  \item readline library\\
-    Used for \ctsimtext\ interactive shell.
+  \item \textbf{zlib}\\
+        Used for PNG file export.\\
+    \urlref{Web site}{http://www.info-zip.org/pub/infozip/zlib/zlib_docs.html}
 
-  \item wxWindows library\\
-  Used for platform-independent graphical interface. The graphical-shell
-  program \ctsim\ requires this library.\\
-  www.wxwindows.org
+  \item \textbf{readline}\\
+    Used for \ctsimtext\ interactive shell.\\
+    \urlref{Web site}{http://www.gnu.org}
 
-  \item dmalloc library\\
-    Used for debugging memory allocation\\
-    www.dmalloc.com
+  \item \textbf{dmalloc}\\
+    Used for debugging memory allocation.\\
+    \urlref{Web site}{http://www.dmalloc.com}
 
 \end{itemize}