INSTALL

   1 CTSim Installation
   2 ==================
   3
   4 Additional Libraries Recommended
   5 --------------------------------
   6
   7 zlib (ftp://ftp.uu.net/pub/archiving/zip/zlib)
   8   Tested with version 1.13
   9   This library is required for libpng (see below)
  10
  11 libpng (ftp://ftp.uu.net/graphics/png/src)
  12   Version 1.0.3 or greater is required. Version 0.89 definitely will
  13   not work.
  14
  15 lam (http://www.mpi.nd.edu/lam/)
  16   There is support is MPI clustering. I use this code at home for my
  17   beowulf cluster.
  18
  19 perl (http://www.perl.org)
  20 apache (http://www.apache.org)
  21   There is support for web-driven CT Simulation. To use this, the
  22   --with-cgibin-dir=..., --with-cgibin-url=..., --with-webdata-dir=...,
  23   --with-webdata-url=..., and --with-html-dir=...  must be set.
  24
  25 CTSim Specific Configuration Help
  26 ---------------------------------
  27
  28   --enable-verbose-warnings
  29                           Enable verbose compiler warnings.
  30   --enable-debug          Turn on debugging
  31   --with-png[=PATH]       Set path of lib PNG installation
  32   --with-lam[=PATH]       Set path of LAM MPI
  33   --with-cgibin-dir=PATH  Set path of CGI binaries directory
  34   --with-cgibin-url=PATH  Set URL path of CGI binaries
  35   --with-webdata-dir=PATH Set path of webdata
  36   --with-webdata-url=PATH Set URL path of webdata
  37   --with-html-dir=PATH    Set directory of html files
  38   --with-x                use the X Window System for interactive graphics
  39
  40 Platforms Supported
  41 -------------------
  42
  43 Recent development is with GNU/Linux. I have tested compilation on
  44 FreeBSD v4.0, BSD/OS v3.0, and Solaris v8, and Microsoft Visual C++ v6.
  45
  46 Microsoft Windows Installation
  47 ------------------------------
  48 Run make.bat from the root directory
  49
  50
  51 Basic Installation
  52 ==================
  53
  54    These are generic installation instructions.
  55
  56    The `configure' shell script attempts to guess correct values for
  57 various system-dependent variables used during compilation.  It uses
  58 those values to create a `Makefile' in each directory of the package.
  59 It may also create one or more `.h' files containing system-dependent
  60 definitions.  Finally, it creates a shell script `config.status' that
  61 you can run in the future to recreate the current configuration, a file
  62 `config.cache' that saves the results of its tests to speed up
  63 reconfiguring, and a file `config.log' containing compiler output
  64 (useful mainly for debugging `configure').
  65
  66    If you need to do unusual things to compile the package, please try
  67 to figure out how `configure' could check whether to do them, and mail
  68 diffs or instructions to the address given in the `README' so they can
  69 be considered for the next release.  If at some point `config.cache'
  70 contains results you don't want to keep, you may remove or edit it.
  71
  72    The file `configure.in' is used to create `configure' by a program
  73 called `autoconf'.  You only need `configure.in' if you want to change
  74 it or regenerate `configure' using a newer version of `autoconf'.
  75
  76 The simplest way to compile this package is:
  77
  78   1. `cd' to the directory containing the package's source code and type
  79      `./configure' to configure the package for your system.  If you're
  80      using `csh' on an old version of System V, you might need to type
  81      `sh ./configure' instead to prevent `csh' from trying to execute
  82      `configure' itself.
  83
  84      Running `configure' takes awhile.  While running, it prints some
  85      messages telling which features it is checking for.
  86
  87   2. Type `make' to compile the package.
  88
  89   3. Optionally, type `make check' to run any self-tests that come with
  90      the package.
  91
  92   4. Type `make install' to install the programs and any data files and
  93      documentation.
  94
  95   5. You can remove the program binaries and object files from the
  96      source code directory by typing `make clean'.  To also remove the
  97      files that `configure' created (so you can compile the package for
  98      a different kind of computer), type `make distclean'.  There is
  99      also a `make maintainer-clean' target, but that is intended mainly
 100      for the package's developers.  If you use it, you may have to get
 101      all sorts of other programs in order to regenerate files that came
 102      with the distribution.
 103
 104 Compilers and Options
 105 =====================
 106
 107    Some systems require unusual options for compilation or linking that
 108 the `configure' script does not know about.  You can give `configure'
 109 initial values for variables by setting them in the environment.  Using
 110 a Bourne-compatible shell, you can do that on the command line like
 111 this:
 112      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 113
 114 Or on systems that have the `env' program, you can do it like this:
 115      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 116
 117 Compiling For Multiple Architectures
 118 ====================================
 119
 120    You can compile the package for more than one kind of computer at the
 121 same time, by placing the object files for each architecture in their
 122 own directory.  To do this, you must use a version of `make' that
 123 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 124 directory where you want the object files and executables to go and run
 125 the `configure' script.  `configure' automatically checks for the
 126 source code in the directory that `configure' is in and in `..'.
 127
 128    If you have to use a `make' that does not supports the `VPATH'
 129 variable, you have to compile the package for one architecture at a time
 130 in the source code directory.  After you have installed the package for
 131 one architecture, use `make distclean' before reconfiguring for another
 132 architecture.
 133
 134 Installation Names
 135 ==================
 136
 137    By default, `make install' will install the package's files in
 138 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 139 installation prefix other than `/usr/local' by giving `configure' the
 140 option `--prefix=PATH'.
 141
 142    You can specify separate installation prefixes for
 143 architecture-specific files and architecture-independent files.  If you
 144 give `configure' the option `--exec-prefix=PATH', the package will use
 145 PATH as the prefix for installing programs and libraries.
 146 Documentation and other data files will still use the regular prefix.
 147
 148    In addition, if you use an unusual directory layout you can give
 149 options like `--bindir=PATH' to specify different values for particular
 150 kinds of files.  Run `configure --help' for a list of the directories
 151 you can set and what kinds of files go in them.
 152
 153    If the package supports it, you can cause programs to be installed
 154 with an extra prefix or suffix on their names by giving `configure' the
 155 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 156
 157 Optional Features
 158 =================
 159
 160    Some packages pay attention to `--enable-FEATURE' options to
 161 `configure', where FEATURE indicates an optional part of the package.
 162 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 163 is something like `gnu-as' or `x' (for the X Window System).  The
 164 `README' should mention any `--enable-' and `--with-' options that the
 165 package recognizes.
 166
 167    For packages that use the X Window System, `configure' can usually
 168 find the X include and library files automatically, but if it doesn't,
 169 you can use the `configure' options `--x-includes=DIR' and
 170 `--x-libraries=DIR' to specify their locations.
 171
 172 Specifying the System Type
 173 ==========================
 174
 175    There may be some features `configure' can not figure out
 176 automatically, but needs to determine by the type of host the package
 177 will run on.  Usually `configure' can figure that out, but if it prints
 178 a message saying it can not guess the host type, give it the
 179 `--host=TYPE' option.  TYPE can either be a short name for the system
 180 type, such as `sun4', or a canonical name with three fields:
 181      CPU-COMPANY-SYSTEM
 182
 183 See the file `config.sub' for the possible values of each field.  If
 184 `config.sub' isn't included in this package, then this package doesn't
 185 need to know the host type.
 186
 187    If you are building compiler tools for cross-compiling, you can also
 188 use the `--target=TYPE' option to select the type of system they will
 189 produce code for and the `--build=TYPE' option to select the type of
 190 system on which you are compiling the package.
 191
 192 Sharing Defaults
 193 ================
 194
 195    If you want to set default values for `configure' scripts to share,
 196 you can create a site shell script called `config.site' that gives
 197 default values for variables like `CC', `cache_file', and `prefix'.
 198 `configure' looks for `PREFIX/share/config.site' if it exists, then
 199 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 200 `CONFIG_SITE' environment variable to the location of the site script.
 201 A warning: not all `configure' scripts look for a site script.
 202
 203 Operation Controls
 204 ==================
 205
 206    `configure' recognizes the following options to control how it
 207 operates.
 208
 209 `--cache-file=FILE'
 210      Use and save the results of the tests in FILE instead of
 211      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 212      debugging `configure'.
 213
 214 `--help'
 215      Print a summary of the options to `configure', and exit.
 216
 217 `--quiet'
 218 `--silent'
 219 `-q'
 220      Do not print messages saying which checks are being made.  To
 221      suppress all normal output, redirect it to `/dev/null' (any error
 222      messages will still be shown).
 223
 224 `--srcdir=DIR'
 225      Look for the package's source code in directory DIR.  Usually
 226      `configure' can determine that directory automatically.
 227
 228 `--version'
 229      Print the version of Autoconf used to generate the `configure'
 230      script, and exit.
 231
 232 `configure' also accepts some other, not widely useful, options.