INSTALL

   1 Installation Instructions
   2 *************************
   3
   4 Specific part for YACS
   5 ~~~~~~~~~~~~~~~~~~~~~~
   6 Prerequisites
   7 =============
   8 YACS needs:
   9  - g++ 3.3.5 or more,
  10  - CPPUNIT
  11  - omniORB 4.05 or more,
  12  - Python
  13
  14 Build and check
  15 ===============
  16
  17 build and install are done in separate directories, not in source directory.
  18 For instance, if the path to YACS sources is ${BASEREP}/YACS_SRC::
  19
  20   cd ${BASEREP}
  21   rm -rf build install
  22   mkdir build install
  23
  24   cd ${BASEREP}/YACS_SRC
  25   ./root_clean
  26   ./build_configure
  27
  28   cd ${BASEREP}/build
  29   ../YACS_SRC/configure --prefix=${BASEREP}/install
  30
  31   make
  32   make check
  33
  34   make install
  35
  36
  37 Generic part
  38 ~~~~~~~~~~~~
  39
  40 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
  41 Software Foundation, Inc.
  42
  43 This file is free documentation; the Free Software Foundation gives
  44 unlimited permission to copy, distribute and modify it.
  45
  46 Basic Installation
  47 ==================
  48
  49 These are generic installation instructions.
  50
  51    The `configure' shell script attempts to guess correct values for
  52 various system-dependent variables used during compilation.  It uses
  53 those values to create a `Makefile' in each directory of the package.
  54 It may also create one or more `.h' files containing system-dependent
  55 definitions.  Finally, it creates a shell script `config.status' that
  56 you can run in the future to recreate the current configuration, and a
  57 file `config.log' containing compiler output (useful mainly for
  58 debugging `configure').
  59
  60    It can also use an optional file (typically called `config.cache'
  61 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  62 the results of its tests to speed up reconfiguring.  (Caching is
  63 disabled by default to prevent problems with accidental use of stale
  64 cache files.)
  65
  66    If you need to do unusual things to compile the package, please try
  67 to figure out how `configure' could check whether to do them, and mail
  68 diffs or instructions to the address given in the `README' so they can
  69 be considered for the next release.  If you are using the cache, and at
  70 some point `config.cache' contains results you don't want to keep, you
  71 may remove or edit it.
  72
  73    The file `configure.ac' (or `configure.in') is used to create
  74 `configure' by a program called `autoconf'.  You only need
  75 `configure.ac' if you want to change it or regenerate `configure' using
  76 a newer version of `autoconf'.
  77
  78 The simplest way to compile this package is:
  79
  80   1. `cd' to the directory containing the package's source code and type
  81      `./configure' to configure the package for your system.  If you're
  82      using `csh' on an old version of System V, you might need to type
  83      `sh ./configure' instead to prevent `csh' from trying to execute
  84      `configure' itself.
  85
  86      Running `configure' takes awhile.  While running, it prints some
  87      messages telling which features it is checking for.
  88
  89   2. Type `make' to compile the package.
  90
  91   3. Optionally, type `make check' to run any self-tests that come with
  92      the package.
  93
  94   4. Type `make install' to install the programs and any data files and
  95      documentation.
  96
  97   5. You can remove the program binaries and object files from the
  98      source code directory by typing `make clean'.  To also remove the
  99      files that `configure' created (so you can compile the package for
 100      a different kind of computer), type `make distclean'.  There is
 101      also a `make maintainer-clean' target, but that is intended mainly
 102      for the package's developers.  If you use it, you may have to get
 103      all sorts of other programs in order to regenerate files that came
 104      with the distribution.
 105
 106 Compilers and Options
 107 =====================
 108
 109 Some systems require unusual options for compilation or linking that the
 110 `configure' script does not know about.  Run `./configure --help' for
 111 details on some of the pertinent environment variables.
 112
 113    You can give `configure' initial values for configuration parameters
 114 by setting variables in the command line or in the environment.  Here
 115 is an example:
 116
 117      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 118
 119    *Note Defining Variables::, for more details.
 120
 121 Compiling For Multiple Architectures
 122 ====================================
 123
 124 You can compile the package for more than one kind of computer at the
 125 same time, by placing the object files for each architecture in their
 126 own directory.  To do this, you must use a version of `make' that
 127 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 128 directory where you want the object files and executables to go and run
 129 the `configure' script.  `configure' automatically checks for the
 130 source code in the directory that `configure' is in and in `..'.
 131
 132    If you have to use a `make' that does not support the `VPATH'
 133 variable, you have to compile the package for one architecture at a
 134 time in the source code directory.  After you have installed the
 135 package for one architecture, use `make distclean' before reconfiguring
 136 for another architecture.
 137
 138 Installation Names
 139 ==================
 140
 141 By default, `make install' will install the package's files in
 142 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 143 installation prefix other than `/usr/local' by giving `configure' the
 144 option `--prefix=PREFIX'.
 145
 146    You can specify separate installation prefixes for
 147 architecture-specific files and architecture-independent files.  If you
 148 give `configure' the option `--exec-prefix=PREFIX', the package will
 149 use PREFIX as the prefix for installing programs and libraries.
 150 Documentation and other data files will still use the regular prefix.
 151
 152    In addition, if you use an unusual directory layout you can give
 153 options like `--bindir=DIR' to specify different values for particular
 154 kinds of files.  Run `configure --help' for a list of the directories
 155 you can set and what kinds of files go in them.
 156
 157    If the package supports it, you can cause programs to be installed
 158 with an extra prefix or suffix on their names by giving `configure' the
 159 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 160
 161 Optional Features
 162 =================
 163
 164 Some packages pay attention to `--enable-FEATURE' options to
 165 `configure', where FEATURE indicates an optional part of the package.
 166 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 167 is something like `gnu-as' or `x' (for the X Window System).  The
 168 `README' should mention any `--enable-' and `--with-' options that the
 169 package recognizes.
 170
 171    For packages that use the X Window System, `configure' can usually
 172 find the X include and library files automatically, but if it doesn't,
 173 you can use the `configure' options `--x-includes=DIR' and
 174 `--x-libraries=DIR' to specify their locations.
 175
 176 Specifying the System Type
 177 ==========================
 178
 179 There may be some features `configure' cannot figure out automatically,
 180 but needs to determine by the type of machine the package will run on.
 181 Usually, assuming the package is built to be run on the _same_
 182 architectures, `configure' can figure that out, but if it prints a
 183 message saying it cannot guess the machine type, give it the
 184 `--build=TYPE' option.  TYPE can either be a short name for the system
 185 type, such as `sun4', or a canonical name which has the form:
 186
 187      CPU-COMPANY-SYSTEM
 188
 189 where SYSTEM can have one of these forms:
 190
 191      OS KERNEL-OS
 192
 193    See the file `config.sub' for the possible values of each field.  If
 194 `config.sub' isn't included in this package, then this package doesn't
 195 need to know the machine type.
 196
 197    If you are _building_ compiler tools for cross-compiling, you should
 198 use the `--target=TYPE' option to select the type of system they will
 199 produce code for.
 200
 201    If you want to _use_ a cross compiler, that generates code for a
 202 platform different from the build platform, you should specify the
 203 "host" platform (i.e., that on which the generated programs will
 204 eventually be run) with `--host=TYPE'.
 205
 206 Sharing Defaults
 207 ================
 208
 209 If you want to set default values for `configure' scripts to share, you
 210 can create a site shell script called `config.site' that gives default
 211 values for variables like `CC', `cache_file', and `prefix'.
 212 `configure' looks for `PREFIX/share/config.site' if it exists, then
 213 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 214 `CONFIG_SITE' environment variable to the location of the site script.
 215 A warning: not all `configure' scripts look for a site script.
 216
 217 Defining Variables
 218 ==================
 219
 220 Variables not defined in a site shell script can be set in the
 221 environment passed to `configure'.  However, some packages may run
 222 configure again during the build, and the customized values of these
 223 variables may be lost.  In order to avoid this problem, you should set
 224 them in the `configure' command line, using `VAR=value'.  For example:
 225
 226      ./configure CC=/usr/local2/bin/gcc
 227
 228 causes the specified `gcc' to be used as the C compiler (unless it is
 229 overridden in the site shell script).  Here is a another example:
 230
 231      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 232
 233 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 234 configuration-related scripts to be executed by `/bin/bash'.
 235
 236 `configure' Invocation
 237 ======================
 238
 239 `configure' recognizes the following options to control how it operates.
 240
 241 `--help'
 242 `-h'
 243      Print a summary of the options to `configure', and exit.
 244
 245 `--version'
 246 `-V'
 247      Print the version of Autoconf used to generate the `configure'
 248      script, and exit.
 249
 250 `--cache-file=FILE'
 251      Enable the cache: use and save the results of the tests in FILE,
 252      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 253      disable caching.
 254
 255 `--config-cache'
 256 `-C'
 257      Alias for `--cache-file=config.cache'.
 258
 259 `--quiet'
 260 `--silent'
 261 `-q'
 262      Do not print messages saying which checks are being made.  To
 263      suppress all normal output, redirect it to `/dev/null' (any error
 264      messages will still be shown).
 265
 266 `--srcdir=DIR'
 267      Look for the package's source code in directory DIR.  Usually
 268      `configure' can determine that directory automatically.
 269
 270 `configure' also accepts some other, not widely useful, options.  Run
 271 `configure --help' for more details.
 272