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 fftw (http://www.fftw.org)
  16   Fastest Fourier Transform in the West. Currently, this library is the
  17   only FFT routines used by CTSim.
  18
  19 wxWindows (http://www.wxwindows.org)
  20   Used by CTSim (src/*) graphic front-end. Platform independent for
  21   GTK, Motif, and Windows32 API's. Requires version 2.4.0 or later.
  22
  23 ctn (http://www.erl.wustl.edu/DICOM/ctn.html)
  24   Used by CTSim for DICOM file import and export
  25
  26 lam (http://www.mpi.nd.edu/lam/)
  27   There is support is MPI clustering. I use this code at home for my
  28   beowulf cluster.
  29
  30 dmalloc (http://www.dmalloc.com)
  31   This adds debugging to memory allocation routines
  32
  33 perl (http://www.perl.org)
  34 apache (http://www.apache.org)
  35   There is support for web-driven CT Simulation. To use this, the
  36   --with-cgibin-dir=..., --with-cgibin-url=..., --with-webdata-dir=...,
  37   --with-webdata-url=..., and --with-html-dir=...  must be set.
  38
  39 readline (http://www.gnu.org)
  40   Used for provide command-line editing in ctsimtext shell
  41
  42
  43 CTSim Specific Configuration Help
  44 ---------------------------------
  45
  46   --enable-verbose-warnings
  47                           Enable verbose compiler warnings.
  48   --enable-debug          Turn on debugging
  49   --with-lam[=PATH]       Set path of LAM MPI
  50   --with-cgibin-dir=PATH  Set path of CGI binaries directory
  51   --with-cgibin-url=PATH  Set URL path of CGI binaries
  52   --with-webdata-dir=PATH Set path of webdata
  53   --with-webdata-url=PATH Set URL path of webdata
  54   --with-html-dir=PATH    Set directory of html files
  55   --with-x                use the X Window System for interactive graphics
  56
  57
  58 PLATFORM SPECIFIC NOTES
  59 =======================
  60
  61 Platforms Tested
  62 ----------------
  63
  64 Recent development is with GNU/Linux. I have tested compilation on
  65 FreeBSD v4.0, BSD/OS v3.0, and Solaris v8 (gcc 32-bit), and IA64 (gcc)
  66 , and Microsoft Windows 2000 (Visual C++ 6.0, cygwin, and mingw32).
  67
  68 Visual C++ Installation
  69 -----------------------
  70 Run make.bat from the root directory (Note, make.bat is out of date
  71 and is currently broken)
  72
  73 CYGWIN v1.1.0
  74 -------------
  75 The file /usr/i686-pc-wygwin/include/cygwin/in.h has a bug. The line
  76       struct in_addr6 sin6_addr;
  77 should be deleted.
  78
  79 getopt_long appears broken, configure.in checks for cygwin to use
  80 bundled version of getopt_long.
  81
  82
  83 Installation Instructions
  84 *************************
  85
  86 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
  87 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
  88
  89    This file is free documentation; the Free Software Foundation gives
  90 unlimited permission to copy, distribute and modify it.
  91
  92 Basic Installation
  93 ==================
  94
  95    Briefly, the shell commands `./configure; make; make install' should
  96 configure, build, and install this package.  The following
  97 more-detailed instructions are generic; see the `README' file for
  98 instructions specific to this package.
  99
 100    The `configure' shell script attempts to guess correct values for
 101 various system-dependent variables used during compilation.  It uses
 102 those values to create a `Makefile' in each directory of the package.
 103 It may also create one or more `.h' files containing system-dependent
 104 definitions.  Finally, it creates a shell script `config.status' that
 105 you can run in the future to recreate the current configuration, and a
 106 file `config.log' containing compiler output (useful mainly for
 107 debugging `configure').
 108
 109    It can also use an optional file (typically called `config.cache'
 110 and enabled with `--cache-file=config.cache' or simply `-C') that saves
 111 the results of its tests to speed up reconfiguring.  Caching is
 112 disabled by default to prevent problems with accidental use of stale
 113 cache files.
 114
 115    If you need to do unusual things to compile the package, please try
 116 to figure out how `configure' could check whether to do them, and mail
 117 diffs or instructions to the address given in the `README' so they can
 118 be considered for the next release.  If you are using the cache, and at
 119 some point `config.cache' contains results you don't want to keep, you
 120 may remove or edit it.
 121
 122    The file `configure.ac' (or `configure.in') is used to create
 123 `configure' by a program called `autoconf'.  You need `configure.ac' if
 124 you want to change it or regenerate `configure' using a newer version
 125 of `autoconf'.
 126
 127 The simplest way to compile this package is:
 128
 129   1. `cd' to the directory containing the package's source code and type
 130      `./configure' to configure the package for your system.
 131
 132      Running `configure' might take a while.  While running, it prints
 133      some messages telling which features it is checking for.
 134
 135   2. Type `make' to compile the package.
 136
 137   3. Optionally, type `make check' to run any self-tests that come with
 138      the package.
 139
 140   4. Type `make install' to install the programs and any data files and
 141      documentation.
 142
 143   5. You can remove the program binaries and object files from the
 144      source code directory by typing `make clean'.  To also remove the
 145      files that `configure' created (so you can compile the package for
 146      a different kind of computer), type `make distclean'.  There is
 147      also a `make maintainer-clean' target, but that is intended mainly
 148      for the package's developers.  If you use it, you may have to get
 149      all sorts of other programs in order to regenerate files that came
 150      with the distribution.
 151
 152   6. Often, you can also type `make uninstall' to remove the installed
 153      files again.
 154
 155 Compilers and Options
 156 =====================
 157
 158    Some systems require unusual options for compilation or linking that
 159 the `configure' script does not know about.  Run `./configure --help'
 160 for details on some of the pertinent environment variables.
 161
 162    You can give `configure' initial values for configuration parameters
 163 by setting variables in the command line or in the environment.  Here
 164 is an example:
 165
 166      ./configure CC=c99 CFLAGS=-g LIBS=-lposix
 167
 168    *Note Defining Variables::, for more details.
 169
 170 Compiling For Multiple Architectures
 171 ====================================
 172
 173    You can compile the package for more than one kind of computer at the
 174 same time, by placing the object files for each architecture in their
 175 own directory.  To do this, you can use GNU `make'.  `cd' to the
 176 directory where you want the object files and executables to go and run
 177 the `configure' script.  `configure' automatically checks for the
 178 source code in the directory that `configure' is in and in `..'.
 179
 180    With a non-GNU `make', it is safer to compile the package for one
 181 architecture at a time in the source code directory.  After you have
 182 installed the package for one architecture, use `make distclean' before
 183 reconfiguring for another architecture.
 184
 185    On MacOS X 10.5 and later systems, you can create libraries and
 186 executables that work on multiple system types--known as "fat" or
 187 "universal" binaries--by specifying multiple `-arch' options to the
 188 compiler but only a single `-arch' option to the preprocessor.  Like
 189 this:
 190
 191      ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 192                  CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
 193                  CPP="gcc -E" CXXCPP="g++ -E"
 194
 195    This is not guaranteed to produce working output in all cases, you
 196 may have to build one architecture at a time and combine the results
 197 using the `lipo' tool if you have problems.
 198
 199 Installation Names
 200 ==================
 201
 202    By default, `make install' installs the package's commands under
 203 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 204 can specify an installation prefix other than `/usr/local' by giving
 205 `configure' the option `--prefix=PREFIX'.
 206
 207    You can specify separate installation prefixes for
 208 architecture-specific files and architecture-independent files.  If you
 209 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 210 PREFIX as the prefix for installing programs and libraries.
 211 Documentation and other data files still use the regular prefix.
 212
 213    In addition, if you use an unusual directory layout you can give
 214 options like `--bindir=DIR' to specify different values for particular
 215 kinds of files.  Run `configure --help' for a list of the directories
 216 you can set and what kinds of files go in them.
 217
 218    If the package supports it, you can cause programs to be installed
 219 with an extra prefix or suffix on their names by giving `configure' the
 220 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 221
 222 Optional Features
 223 =================
 224
 225    Some packages pay attention to `--enable-FEATURE' options to
 226 `configure', where FEATURE indicates an optional part of the package.
 227 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 228 is something like `gnu-as' or `x' (for the X Window System).  The
 229 `README' should mention any `--enable-' and `--with-' options that the
 230 package recognizes.
 231
 232    For packages that use the X Window System, `configure' can usually
 233 find the X include and library files automatically, but if it doesn't,
 234 you can use the `configure' options `--x-includes=DIR' and
 235 `--x-libraries=DIR' to specify their locations.
 236
 237 Particular systems
 238 ==================
 239
 240    On HP-UX, the default C compiler is not ANSI C compatible.  If GNU
 241 CC is not installed, it is recommended to use the following options in
 242 order to use an ANSI C compiler:
 243
 244      ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
 245
 246 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
 247
 248    On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
 249 parse its `<wchar.h>' header file.  The option `-nodtk' can be used as
 250 a workaround.  If GNU CC is not installed, it is therefore recommended
 251 to try
 252
 253      ./configure CC="cc"
 254
 255 and if that doesn't work, try
 256
 257      ./configure CC="cc -nodtk"
 258
 259    On Solaris, don't put `/usr/ucb' early in your `PATH'.  This
 260 directory contains several dysfunctional programs; working variants of
 261 these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'
 262 in your `PATH', put it _after_ `/usr/bin'.
 263
 264    On Haiku, software installed for all users goes in `/boot/common',
 265 not `/usr/local'.  It is recommended to use the following options:
 266
 267      ./configure --prefix=/boot/common
 268
 269 Specifying the System Type
 270 ==========================
 271
 272    There may be some features `configure' cannot figure out
 273 automatically, but needs to determine by the type of machine the package
 274 will run on.  Usually, assuming the package is built to be run on the
 275 _same_ architectures, `configure' can figure that out, but if it prints
 276 a message saying it cannot guess the machine type, give it the
 277 `--build=TYPE' option.  TYPE can either be a short name for the system
 278 type, such as `sun4', or a canonical name which has the form:
 279
 280      CPU-COMPANY-SYSTEM
 281
 282 where SYSTEM can have one of these forms:
 283
 284      OS
 285      KERNEL-OS
 286
 287    See the file `config.sub' for the possible values of each field.  If
 288 `config.sub' isn't included in this package, then this package doesn't
 289 need to know the machine type.
 290
 291    If you are _building_ compiler tools for cross-compiling, you should
 292 use the option `--target=TYPE' to select the type of system they will
 293 produce code for.
 294
 295    If you want to _use_ a cross compiler, that generates code for a
 296 platform different from the build platform, you should specify the
 297 "host" platform (i.e., that on which the generated programs will
 298 eventually be run) with `--host=TYPE'.
 299
 300 Sharing Defaults
 301 ================
 302
 303    If you want to set default values for `configure' scripts to share,
 304 you can create a site shell script called `config.site' that gives
 305 default values for variables like `CC', `cache_file', and `prefix'.
 306 `configure' looks for `PREFIX/share/config.site' if it exists, then
 307 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 308 `CONFIG_SITE' environment variable to the location of the site script.
 309 A warning: not all `configure' scripts look for a site script.
 310
 311 Defining Variables
 312 ==================
 313
 314    Variables not defined in a site shell script can be set in the
 315 environment passed to `configure'.  However, some packages may run
 316 configure again during the build, and the customized values of these
 317 variables may be lost.  In order to avoid this problem, you should set
 318 them in the `configure' command line, using `VAR=value'.  For example:
 319
 320      ./configure CC=/usr/local2/bin/gcc
 321
 322 causes the specified `gcc' to be used as the C compiler (unless it is
 323 overridden in the site shell script).
 324
 325 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 326 an Autoconf bug.  Until the bug is fixed you can use this workaround:
 327
 328      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 329
 330 `configure' Invocation
 331 ======================
 332
 333    `configure' recognizes the following options to control how it
 334 operates.
 335
 336 `--help'
 337 `-h'
 338      Print a summary of all of the options to `configure', and exit.
 339
 340 `--help=short'
 341 `--help=recursive'
 342      Print a summary of the options unique to this package's
 343      `configure', and exit.  The `short' variant lists options used
 344      only in the top level, while the `recursive' variant lists options
 345      also present in any nested packages.
 346
 347 `--version'
 348 `-V'
 349      Print the version of Autoconf used to generate the `configure'
 350      script, and exit.
 351
 352 `--cache-file=FILE'
 353      Enable the cache: use and save the results of the tests in FILE,
 354      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 355      disable caching.
 356
 357 `--config-cache'
 358 `-C'
 359      Alias for `--cache-file=config.cache'.
 360
 361 `--quiet'
 362 `--silent'
 363 `-q'
 364      Do not print messages saying which checks are being made.  To
 365      suppress all normal output, redirect it to `/dev/null' (any error
 366      messages will still be shown).
 367
 368 `--srcdir=DIR'
 369      Look for the package's source code in directory DIR.  Usually
 370      `configure' can determine that directory automatically.
 371
 372 `--prefix=DIR'
 373      Use DIR as the installation prefix.  *Note Installation Names::
 374      for more details, including other options available for fine-tuning
 375      the installation locations.
 376
 377 `--no-create'
 378 `-n'
 379      Run the configure checks, but stop before creating any output
 380      files.
 381
 382 `configure' also accepts some other, not widely useful, options.  Run
 383 `configure --help' for more details.