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