binaries/windows/clustalo/INSTALL.txt

   1 The impatient can try:\r
   2 \r
   3 $ ./configure\r
   4 $ make\r
   5 $ make install\r
   6 \r
   7 \r
   8 Clustal-Omega needs argtable2 (http://argtable.sourceforge.net/). If\r
   9 argtable2 is installed in a non-standard directory you might have to\r
  10 point configure to its installation directory. For example, if you are\r
  11 on a Mac and have argtable installed via MacPorts then you should use\r
  12 the following command line:\r
  13 \r
  14 $ ./configure CFLAGS='-I/opt/local/include' LDFLAGS='-L/opt/local/lib'\r
  15 \r
  16 ClustalO will automatically support multi-threading if your compiler\r
  17 supports OpenMP. For some reason automake's OpenMP detection for\r
  18 Apple's gcc is broken. You can force OpenMP detection by calling configure \r
  19 like so:\r
  20 \r
  21 $ ./configure OPENMP_CFLAGS='-fopenmp' CFLAGS='-DHAVE_OPENMP'\r
  22 \r
  23 You could use a non-Apple gcc installed via MacPorts, adding\r
  24 \r
  25 CC=/opt/local/bin/gcc-mp-4.5\r
  26 \r
  27 to the configure call (you will have to change the exact string to match\r
  28 your gcc version).\r
  29 \r
  30 See below for generic installation instructions:\r
  31 \r
  32 ----------------------------------------------------------------------\r
  33 \r
  34 \r
  35 \r
  36 Installation Instructions\r
  37 *************************\r
  38 \r
  39 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,\r
  40 2006, 2007, 2008, 2009 Free Software Foundation, Inc.\r
  41 \r
  42    Copying and distribution of this file, with or without modification,\r
  43 are permitted in any medium without royalty provided the copyright\r
  44 notice and this notice are preserved.  This file is offered as-is,\r
  45 without warranty of any kind.\r
  46 \r
  47 Basic Installation\r
  48 ==================\r
  49 \r
  50    Briefly, the shell commands `./configure; make; make install' should\r
  51 configure, build, and install this package.  The following\r
  52 more-detailed instructions are generic; see the `README' file for\r
  53 instructions specific to this package.  Some packages provide this\r
  54 `INSTALL' file but do not implement all of the features documented\r
  55 below.  The lack of an optional feature in a given package is not\r
  56 necessarily a bug.  More recommendations for GNU packages can be found\r
  57 in *note Makefile Conventions: (standards)Makefile Conventions.\r
  58 \r
  59    The `configure' shell script attempts to guess correct values for\r
  60 various system-dependent variables used during compilation.  It uses\r
  61 those values to create a `Makefile' in each directory of the package.\r
  62 It may also create one or more `.h' files containing system-dependent\r
  63 definitions.  Finally, it creates a shell script `config.status' that\r
  64 you can run in the future to recreate the current configuration, and a\r
  65 file `config.log' containing compiler output (useful mainly for\r
  66 debugging `configure').\r
  67 \r
  68    It can also use an optional file (typically called `config.cache'\r
  69 and enabled with `--cache-file=config.cache' or simply `-C') that saves\r
  70 the results of its tests to speed up reconfiguring.  Caching is\r
  71 disabled by default to prevent problems with accidental use of stale\r
  72 cache files.\r
  73 \r
  74    If you need to do unusual things to compile the package, please try\r
  75 to figure out how `configure' could check whether to do them, and mail\r
  76 diffs or instructions to the address given in the `README' so they can\r
  77 be considered for the next release.  If you are using the cache, and at\r
  78 some point `config.cache' contains results you don't want to keep, you\r
  79 may remove or edit it.\r
  80 \r
  81    The file `configure.ac' (or `configure.in') is used to create\r
  82 `configure' by a program called `autoconf'.  You need `configure.ac' if\r
  83 you want to change it or regenerate `configure' using a newer version\r
  84 of `autoconf'.\r
  85 \r
  86    The simplest way to compile this package is:\r
  87 \r
  88   1. `cd' to the directory containing the package's source code and type\r
  89      `./configure' to configure the package for your system.\r
  90 \r
  91      Running `configure' might take a while.  While running, it prints\r
  92      some messages telling which features it is checking for.\r
  93 \r
  94   2. Type `make' to compile the package.\r
  95 \r
  96   3. Optionally, type `make check' to run any self-tests that come with\r
  97      the package, generally using the just-built uninstalled binaries.\r
  98 \r
  99   4. Type `make install' to install the programs and any data files and\r
 100      documentation.  When installing into a prefix owned by root, it is\r
 101      recommended that the package be configured and built as a regular\r
 102      user, and only the `make install' phase executed with root\r
 103      privileges.\r
 104 \r
 105   5. Optionally, type `make installcheck' to repeat any self-tests, but\r
 106      this time using the binaries in their final installed location.\r
 107      This target does not install anything.  Running this target as a\r
 108      regular user, particularly if the prior `make install' required\r
 109      root privileges, verifies that the installation completed\r
 110      correctly.\r
 111 \r
 112   6. You can remove the program binaries and object files from the\r
 113      source code directory by typing `make clean'.  To also remove the\r
 114      files that `configure' created (so you can compile the package for\r
 115      a different kind of computer), type `make distclean'.  There is\r
 116      also a `make maintainer-clean' target, but that is intended mainly\r
 117      for the package's developers.  If you use it, you may have to get\r
 118      all sorts of other programs in order to regenerate files that came\r
 119      with the distribution.\r
 120 \r
 121   7. Often, you can also type `make uninstall' to remove the installed\r
 122      files again.  In practice, not all packages have tested that\r
 123      uninstallation works correctly, even though it is required by the\r
 124      GNU Coding Standards.\r
 125 \r
 126   8. Some packages, particularly those that use Automake, provide `make\r
 127      distcheck', which can by used by developers to test that all other\r
 128      targets like `make install' and `make uninstall' work correctly.\r
 129      This target is generally not run by end users.\r
 130 \r
 131 Compilers and Options\r
 132 =====================\r
 133 \r
 134    Some systems require unusual options for compilation or linking that\r
 135 the `configure' script does not know about.  Run `./configure --help'\r
 136 for details on some of the pertinent environment variables.\r
 137 \r
 138    You can give `configure' initial values for configuration parameters\r
 139 by setting variables in the command line or in the environment.  Here\r
 140 is an example:\r
 141 \r
 142      ./configure CC=c99 CFLAGS=-g LIBS=-lposix\r
 143 \r
 144    *Note Defining Variables::, for more details.\r
 145 \r
 146 Compiling For Multiple Architectures\r
 147 ====================================\r
 148 \r
 149    You can compile the package for more than one kind of computer at the\r
 150 same time, by placing the object files for each architecture in their\r
 151 own directory.  To do this, you can use GNU `make'.  `cd' to the\r
 152 directory where you want the object files and executables to go and run\r
 153 the `configure' script.  `configure' automatically checks for the\r
 154 source code in the directory that `configure' is in and in `..'.  This\r
 155 is known as a "VPATH" build.\r
 156 \r
 157    With a non-GNU `make', it is safer to compile the package for one\r
 158 architecture at a time in the source code directory.  After you have\r
 159 installed the package for one architecture, use `make distclean' before\r
 160 reconfiguring for another architecture.\r
 161 \r
 162    On MacOS X 10.5 and later systems, you can create libraries and\r
 163 executables that work on multiple system types--known as "fat" or\r
 164 "universal" binaries--by specifying multiple `-arch' options to the\r
 165 compiler but only a single `-arch' option to the preprocessor.  Like\r
 166 this:\r
 167 \r
 168      ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \\r
 169                  CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \\r
 170                  CPP="gcc -E" CXXCPP="g++ -E"\r
 171 \r
 172    This is not guaranteed to produce working output in all cases, you\r
 173 may have to build one architecture at a time and combine the results\r
 174 using the `lipo' tool if you have problems.\r
 175 \r
 176 Installation Names\r
 177 ==================\r
 178 \r
 179    By default, `make install' installs the package's commands under\r
 180 `/usr/local/bin', include files under `/usr/local/include', etc.  You\r
 181 can specify an installation prefix other than `/usr/local' by giving\r
 182 `configure' the option `--prefix=PREFIX', where PREFIX must be an\r
 183 absolute file name.\r
 184 \r
 185    You can specify separate installation prefixes for\r
 186 architecture-specific files and architecture-independent files.  If you\r
 187 pass the option `--exec-prefix=PREFIX' to `configure', the package uses\r
 188 PREFIX as the prefix for installing programs and libraries.\r
 189 Documentation and other data files still use the regular prefix.\r
 190 \r
 191    In addition, if you use an unusual directory layout you can give\r
 192 options like `--bindir=DIR' to specify different values for particular\r
 193 kinds of files.  Run `configure --help' for a list of the directories\r
 194 you can set and what kinds of files go in them.  In general, the\r
 195 default for these options is expressed in terms of `${prefix}', so that\r
 196 specifying just `--prefix' will affect all of the other directory\r
 197 specifications that were not explicitly provided.\r
 198 \r
 199    The most portable way to affect installation locations is to pass the\r
 200 correct locations to `configure'; however, many packages provide one or\r
 201 both of the following shortcuts of passing variable assignments to the\r
 202 `make install' command line to change installation locations without\r
 203 having to reconfigure or recompile.\r
 204 \r
 205    The first method involves providing an override variable for each\r
 206 affected directory.  For example, `make install\r
 207 prefix=/alternate/directory' will choose an alternate location for all\r
 208 directory configuration variables that were expressed in terms of\r
 209 `${prefix}'.  Any directories that were specified during `configure',\r
 210 but not in terms of `${prefix}', must each be overridden at install\r
 211 time for the entire installation to be relocated.  The approach of\r
 212 makefile variable overrides for each directory variable is required by\r
 213 the GNU Coding Standards, and ideally causes no recompilation.\r
 214 However, some platforms have known limitations with the semantics of\r
 215 shared libraries that end up requiring recompilation when using this\r
 216 method, particularly noticeable in packages that use GNU Libtool.\r
 217 \r
 218    The second method involves providing the `DESTDIR' variable.  For\r
 219 example, `make install DESTDIR=/alternate/directory' will prepend\r
 220 `/alternate/directory' before all installation names.  The approach of\r
 221 `DESTDIR' overrides is not required by the GNU Coding Standards, and\r
 222 does not work on platforms that have drive letters.  On the other hand,\r
 223 it does better at avoiding recompilation issues, and works well even\r
 224 when some directory options were not specified in terms of `${prefix}'\r
 225 at `configure' time.\r
 226 \r
 227 Optional Features\r
 228 =================\r
 229 \r
 230    If the package supports it, you can cause programs to be installed\r
 231 with an extra prefix or suffix on their names by giving `configure' the\r
 232 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.\r
 233 \r
 234    Some packages pay attention to `--enable-FEATURE' options to\r
 235 `configure', where FEATURE indicates an optional part of the package.\r
 236 They may also pay attention to `--with-PACKAGE' options, where PACKAGE\r
 237 is something like `gnu-as' or `x' (for the X Window System).  The\r
 238 `README' should mention any `--enable-' and `--with-' options that the\r
 239 package recognizes.\r
 240 \r
 241    For packages that use the X Window System, `configure' can usually\r
 242 find the X include and library files automatically, but if it doesn't,\r
 243 you can use the `configure' options `--x-includes=DIR' and\r
 244 `--x-libraries=DIR' to specify their locations.\r
 245 \r
 246    Some packages offer the ability to configure how verbose the\r
 247 execution of `make' will be.  For these packages, running `./configure\r
 248 --enable-silent-rules' sets the default to minimal output, which can be\r
 249 overridden with `make V=1'; while running `./configure\r
 250 --disable-silent-rules' sets the default to verbose, which can be\r
 251 overridden with `make V=0'.\r
 252 \r
 253 Particular systems\r
 254 ==================\r
 255 \r
 256    On HP-UX, the default C compiler is not ANSI C compatible.  If GNU\r
 257 CC is not installed, it is recommended to use the following options in\r
 258 order to use an ANSI C compiler:\r
 259 \r
 260      ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"\r
 261 \r
 262 and if that doesn't work, install pre-built binaries of GCC for HP-UX.\r
 263 \r
 264    On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot\r
 265 parse its `<wchar.h>' header file.  The option `-nodtk' can be used as\r
 266 a workaround.  If GNU CC is not installed, it is therefore recommended\r
 267 to try\r
 268 \r
 269      ./configure CC="cc"\r
 270 \r
 271 and if that doesn't work, try\r
 272 \r
 273      ./configure CC="cc -nodtk"\r
 274 \r
 275    On Solaris, don't put `/usr/ucb' early in your `PATH'.  This\r
 276 directory contains several dysfunctional programs; working variants of\r
 277 these programs are available in `/usr/bin'.  So, if you need `/usr/ucb'\r
 278 in your `PATH', put it _after_ `/usr/bin'.\r
 279 \r
 280    On Haiku, software installed for all users goes in `/boot/common',\r
 281 not `/usr/local'.  It is recommended to use the following options:\r
 282 \r
 283      ./configure --prefix=/boot/common\r
 284 \r
 285 Specifying the System Type\r
 286 ==========================\r
 287 \r
 288    There may be some features `configure' cannot figure out\r
 289 automatically, but needs to determine by the type of machine the package\r
 290 will run on.  Usually, assuming the package is built to be run on the\r
 291 _same_ architectures, `configure' can figure that out, but if it prints\r
 292 a message saying it cannot guess the machine type, give it the\r
 293 `--build=TYPE' option.  TYPE can either be a short name for the system\r
 294 type, such as `sun4', or a canonical name which has the form:\r
 295 \r
 296      CPU-COMPANY-SYSTEM\r
 297 \r
 298 where SYSTEM can have one of these forms:\r
 299 \r
 300      OS\r
 301      KERNEL-OS\r
 302 \r
 303    See the file `config.sub' for the possible values of each field.  If\r
 304 `config.sub' isn't included in this package, then this package doesn't\r
 305 need to know the machine type.\r
 306 \r
 307    If you are _building_ compiler tools for cross-compiling, you should\r
 308 use the option `--target=TYPE' to select the type of system they will\r
 309 produce code for.\r
 310 \r
 311    If you want to _use_ a cross compiler, that generates code for a\r
 312 platform different from the build platform, you should specify the\r
 313 "host" platform (i.e., that on which the generated programs will\r
 314 eventually be run) with `--host=TYPE'.\r
 315 \r
 316 Sharing Defaults\r
 317 ================\r
 318 \r
 319    If you want to set default values for `configure' scripts to share,\r
 320 you can create a site shell script called `config.site' that gives\r
 321 default values for variables like `CC', `cache_file', and `prefix'.\r
 322 `configure' looks for `PREFIX/share/config.site' if it exists, then\r
 323 `PREFIX/etc/config.site' if it exists.  Or, you can set the\r
 324 `CONFIG_SITE' environment variable to the location of the site script.\r
 325 A warning: not all `configure' scripts look for a site script.\r
 326 \r
 327 Defining Variables\r
 328 ==================\r
 329 \r
 330    Variables not defined in a site shell script can be set in the\r
 331 environment passed to `configure'.  However, some packages may run\r
 332 configure again during the build, and the customized values of these\r
 333 variables may be lost.  In order to avoid this problem, you should set\r
 334 them in the `configure' command line, using `VAR=value'.  For example:\r
 335 \r
 336      ./configure CC=/usr/local2/bin/gcc\r
 337 \r
 338 causes the specified `gcc' to be used as the C compiler (unless it is\r
 339 overridden in the site shell script).\r
 340 \r
 341 Unfortunately, this technique does not work for `CONFIG_SHELL' due to\r
 342 an Autoconf bug.  Until the bug is fixed you can use this workaround:\r
 343 \r
 344      CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash\r
 345 \r
 346 `configure' Invocation\r
 347 ======================\r
 348 \r
 349    `configure' recognizes the following options to control how it\r
 350 operates.\r
 351 \r
 352 `--help'\r
 353 `-h'\r
 354      Print a summary of all of the options to `configure', and exit.\r
 355 \r
 356 `--help=short'\r
 357 `--help=recursive'\r
 358      Print a summary of the options unique to this package's\r
 359      `configure', and exit.  The `short' variant lists options used\r
 360      only in the top level, while the `recursive' variant lists options\r
 361      also present in any nested packages.\r
 362 \r
 363 `--version'\r
 364 `-V'\r
 365      Print the version of Autoconf used to generate the `configure'\r
 366      script, and exit.\r
 367 \r
 368 `--cache-file=FILE'\r
 369      Enable the cache: use and save the results of the tests in FILE,\r
 370      traditionally `config.cache'.  FILE defaults to `/dev/null' to\r
 371      disable caching.\r
 372 \r
 373 `--config-cache'\r
 374 `-C'\r
 375      Alias for `--cache-file=config.cache'.\r
 376 \r
 377 `--quiet'\r
 378 `--silent'\r
 379 `-q'\r
 380      Do not print messages saying which checks are being made.  To\r
 381      suppress all normal output, redirect it to `/dev/null' (any error\r
 382      messages will still be shown).\r
 383 \r
 384 `--srcdir=DIR'\r
 385      Look for the package's source code in directory DIR.  Usually\r
 386      `configure' can determine that directory automatically.\r
 387 \r
 388 `--prefix=DIR'\r
 389      Use DIR as the installation prefix.  *note Installation Names::\r
 390      for more details, including other options available for fine-tuning\r
 391      the installation locations.\r
 392 \r
 393 `--no-create'\r
 394 `-n'\r
 395      Run the configure checks, but stop before creating any output\r
 396      files.\r
 397 \r
 398 `configure' also accepts some other, not widely useful, options.  Run\r
 399 `configure --help' for more details.\r
 400 \r