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