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