1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
|
Quick Summary
=============
To build and install the Funtools package, simply execute:
./configure # site-specific configuration
make # build the software
make install # install it
make clean # clean up unneeded temp files
You might want to install in a directory other than /usr/local, so as not to
require root access. To do this, configure for a different install directory:
./configure --prefix=<top_level_install_dir>
e.g.,
./configure --prefix=/soft/saord
Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
and include files in /soft/saord/include. Indeed, we do this at SAO and
recommend it as a general rule, in order to keep SAORD software in one place
that does not conflict with other installations. Note that you will need to
add the bin directory to your path.
The build ("make") takes only a minute or so on modern machines. To
monitor its progress and/or check for errors, redirect output to a file
and use the 'tail' command:
make >& foo.log &; tail -f foo.log # csh
or
make 1>foo.log 2>&1 &; tail -f foo.log # sh, bash
NB: Windows users
=================
To build funtools on a Windows platform, you first need to install
the Cygwin package from:
http://cygwin.com/
From the Web page:
Cygwin is a Linux-like environment for Windows. It consists of two
parts: A DLL (cygwin1.dll) which acts as a Linux API emulation layer
providing substantial Linux API functionality. A collection of tools
which provide Linux look and feel.
When installing cygwin, make sure you install 'gcc' and 'make' from the
Development package. I think that's all you need ...
Details of Installation
=======================
NB: These are generic installation instructions, modified for Funtools.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.
The file `configure.in' is used to create `configure' by a program
called `autoconf'. You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.
The simplest way to compile this package is:
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
1. `cd' to the directory containing the package's source code and type
"./configure". This runs a configuration script created by GNU
autoconf, which configures Funtools for your system and creates a
Makefile. The configure script allows you to customize the Funtools
configuration for your site; for details on how you can do this,
type "./configure -help" or refer to the autoconf documentation (not
included here). The Funtools "configure" script supports the following
special switch(es) in addition to the standard ones:
--enable-shared=yes|link|no
Build shared libraries in addition to the
default static library. There are two options:
If the value is "yes", shared libraries are
built but not used to link xpa programs.
If the value is "link", shared libraries are
used to link xpa programs. If therefore becomes
your responsibility to put the shared library
where it can be found (or use LD_LIBRARY_PATH).
--enable-dl=yes|no
With gcc available, perform on-the-fly filtering
by compiling a shared object and dynamically
loading it into the executable. The default is
to compile and link a separate slave program.
(Surprisingly, processing speed is about the
same for both methods.)
--enable-mainlib=yes|no
Build funtools mainlib support, which allows
user programs to call funtools as subroutines.
This is an experimental interface.
Standard options are listed below. the most important of which
is --prefix (to specify where to install) and --exec-prefix (where to
install executables, if the top level is different from where libraries
and include files are being installed. At SAO, we just use --prefix.
We recommend --prefix be set to a directory that will hold saord software
(e.g., --prefix=/soft/saord) in order to make management of our software
easier.
NB: be sure to use only absolute path names (those starting with "/")
in the --prefix and --exec_prefix options. (The configure options we
use at SAO for various machines are given as examples in the script
file called "saoconfig" in this directory.)
NB: Please avoid use of --prefix with 'make install' to change the
install directory. We use the original value of --prefix to determine
where compiled objects are located for linking slave filter programs.
The slave will look in that directory for imregions.o and evregions.o.
If you change the install directory, you will not be able to use these
precompiled objects. Instead, each filter will have to recompile the
region code.
Compiler flags can be placed on the configure command line after the
switches. For example, to use the icc compiler under Linux, you can
configure this way:
./configure --prefix=... CC=icc CFLAGS="..."
If you are going to be dealing with data files larger than 2Gb,
you will need to build in large file support. For gcc and many other
compilers, this is done using the following CFLAGS:
./configure CFLAGS="-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64"
Of course, you can put other switches into CFLAGS as needed:
./configure CFLAGS="-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64 -Wall -g"
2. Type `make' to compile the package. This will create the libfuntools.a
library and the Funtools utility programs (funcnts, fundisp, etc.)
3. You can build the libxpa.so shared library manually by executing:
make shlib
at this point.
4. Type "make install" to install Funtools libraries and binaries in
standard places. You'll need write permission on the installation
directories to do this. The installation directories are
determined by the "configure" script and may be specified with
the --prefix option to "configure". See the Makefile for information
on what directories were chosen.
5. There are .html help files in the doc directory. You can copy
these files to a more convenient location, if you like. We
did not automate this step because we did not know where to
copy these files by default. (NB: The help.html file is the
top level index file.)
6. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make Distclean'. The latter
also removes all Makefiles (except the one at the top level).
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure'
initial values for variables by setting them in the environment:
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
You also can use this facility to specify a compiler other than the default
gcc (if it exists).
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/lib', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH':
e.g.,
./configure --prefix=/soft/saord
Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
and include files in /soft/saord/include. We recommend this as a general rule,
in order to keep SAORD software in one place that does not conflict with other
installations. Note that you will need to add the bin directory to your path.
You can specify separate installation prefixes for architecture-specific
files and architecture-independent files. If you give `configure' the option
`--exec-prefix=PATH', the package will use PATH as the prefix for installing
programs and libraries. Documentation and other data files will still use the
regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
Specifying the System Type
==========================
There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
CPU-COMPANY-SYSTEM
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.
If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Operation Controls
==================
`configure' recognizes the following options to control how it
operates.
`--cache-file=FILE'
Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
debugging `configure'.
`--help'
Print a summary of the options to `configure', and exit.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`--version'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`configure' also accepts some other, not widely useful, options.
If you have questions, please contact us at: saord@cfa.harvard.edu.
Eric Mandel
|