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