Back to home page

MITgcm

 
 

    


Warning, /tools/mpack-1.6/INSTALL is written in an unsupported language. File is not indexed.

view on githubraw file Latest commit ec6cf3b0 on 2003-08-26 20:45:25 UTC
ec6cf3b09d Ed H*0001 Basic Installation
                0002 ==================
                0003 
                0004    These are generic installation instructions.
                0005 
                0006    The `configure' shell script attempts to guess correct values for
                0007 various system-dependent variables used during compilation.  It uses
                0008 those values to create a `Makefile' in each directory of the package.
                0009 It may also create one or more `.h' files containing system-dependent
                0010 definitions.  Finally, it creates a shell script `config.status' that
                0011 you can run in the future to recreate the current configuration, a file
                0012 `config.cache' that saves the results of its tests to speed up
                0013 reconfiguring, and a file `config.log' containing compiler output
                0014 (useful mainly for debugging `configure').
                0015 
                0016    If you need to do unusual things to compile the package, please try
                0017 to figure out how `configure' could check whether to do them, and mail
                0018 diffs or instructions to the address given in the `README' so they can
                0019 be considered for the next release.  If at some point `config.cache'
                0020 contains results you don't want to keep, you may remove or edit it.
                0021 
                0022    The file `configure.in' is used to create `configure' by a program
                0023 called `autoconf'.  You only need `configure.in' if you want to change
                0024 it or regenerate `configure' using a newer version of `autoconf'.
                0025 
                0026 The simplest way to compile this package is:
                0027 
                0028   1. `cd' to the directory containing the package's source code and type
                0029      `./configure' to configure the package for your system.  If you're
                0030      using `csh' on an old version of System V, you might need to type
                0031      `sh ./configure' instead to prevent `csh' from trying to execute
                0032      `configure' itself.
                0033 
                0034      Running `configure' takes awhile.  While running, it prints some
                0035      messages telling which features it is checking for.
                0036 
                0037   2. Type `make' to compile the package.
                0038 
                0039   3. Optionally, type `make check' to run any self-tests that come with
                0040      the package.
                0041 
                0042   4. Type `make install' to install the programs and any data files and
                0043      documentation.
                0044 
                0045   5. You can remove the program binaries and object files from the
                0046      source code directory by typing `make clean'.  To also remove the
                0047      files that `configure' created (so you can compile the package for
                0048      a different kind of computer), type `make distclean'.  There is
                0049      also a `make maintainer-clean' target, but that is intended mainly
                0050      for the package's developers.  If you use it, you may have to get
                0051      all sorts of other programs in order to regenerate files that came
                0052      with the distribution.
                0053 
                0054 Compilers and Options
                0055 =====================
                0056 
                0057    Some systems require unusual options for compilation or linking that
                0058 the `configure' script does not know about.  You can give `configure'
                0059 initial values for variables by setting them in the environment.  Using
                0060 a Bourne-compatible shell, you can do that on the command line like
                0061 this:
                0062      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
                0063 
                0064 Or on systems that have the `env' program, you can do it like this:
                0065      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
                0066 
                0067 Compiling For Multiple Architectures
                0068 ====================================
                0069 
                0070    You can compile the package for more than one kind of computer at the
                0071 same time, by placing the object files for each architecture in their
                0072 own directory.  To do this, you must use a version of `make' that
                0073 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
                0074 directory where you want the object files and executables to go and run
                0075 the `configure' script.  `configure' automatically checks for the
                0076 source code in the directory that `configure' is in and in `..'.
                0077 
                0078    If you have to use a `make' that does not supports the `VPATH'
                0079 variable, you have to compile the package for one architecture at a time
                0080 in the source code directory.  After you have installed the package for
                0081 one architecture, use `make distclean' before reconfiguring for another
                0082 architecture.
                0083 
                0084 Installation Names
                0085 ==================
                0086 
                0087    By default, `make install' will install the package's files in
                0088 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
                0089 installation prefix other than `/usr/local' by giving `configure' the
                0090 option `--prefix=PATH'.
                0091 
                0092    You can specify separate installation prefixes for
                0093 architecture-specific files and architecture-independent files.  If you
                0094 give `configure' the option `--exec-prefix=PATH', the package will use
                0095 PATH as the prefix for installing programs and libraries.
                0096 Documentation and other data files will still use the regular prefix.
                0097 
                0098    In addition, if you use an unusual directory layout you can give
                0099 options like `--bindir=PATH' to specify different values for particular
                0100 kinds of files.  Run `configure --help' for a list of the directories
                0101 you can set and what kinds of files go in them.
                0102 
                0103    If the package supports it, you can cause programs to be installed
                0104 with an extra prefix or suffix on their names by giving `configure' the
                0105 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
                0106 
                0107 Optional Features
                0108 =================
                0109 
                0110    Some packages pay attention to `--enable-FEATURE' options to
                0111 `configure', where FEATURE indicates an optional part of the package.
                0112 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
                0113 is something like `gnu-as' or `x' (for the X Window System).  The
                0114 `README' should mention any `--enable-' and `--with-' options that the
                0115 package recognizes.
                0116 
                0117    For packages that use the X Window System, `configure' can usually
                0118 find the X include and library files automatically, but if it doesn't,
                0119 you can use the `configure' options `--x-includes=DIR' and
                0120 `--x-libraries=DIR' to specify their locations.
                0121 
                0122 Specifying the System Type
                0123 ==========================
                0124 
                0125    There may be some features `configure' can not figure out
                0126 automatically, but needs to determine by the type of host the package
                0127 will run on.  Usually `configure' can figure that out, but if it prints
                0128 a message saying it can not guess the host type, give it the
                0129 `--host=TYPE' option.  TYPE can either be a short name for the system
                0130 type, such as `sun4', or a canonical name with three fields:
                0131      CPU-COMPANY-SYSTEM
                0132 
                0133 See the file `config.sub' for the possible values of each field.  If
                0134 `config.sub' isn't included in this package, then this package doesn't
                0135 need to know the host type.
                0136 
                0137    If you are building compiler tools for cross-compiling, you can also
                0138 use the `--target=TYPE' option to select the type of system they will
                0139 produce code for and the `--build=TYPE' option to select the type of
                0140 system on which you are compiling the package.
                0141 
                0142 Sharing Defaults
                0143 ================
                0144 
                0145    If you want to set default values for `configure' scripts to share,
                0146 you can create a site shell script called `config.site' that gives
                0147 default values for variables like `CC', `cache_file', and `prefix'.
                0148 `configure' looks for `PREFIX/share/config.site' if it exists, then
                0149 `PREFIX/etc/config.site' if it exists.  Or, you can set the
                0150 `CONFIG_SITE' environment variable to the location of the site script.
                0151 A warning: not all `configure' scripts look for a site script.
                0152 
                0153 Operation Controls
                0154 ==================
                0155 
                0156    `configure' recognizes the following options to control how it
                0157 operates.
                0158 
                0159 `--cache-file=FILE'
                0160      Use and save the results of the tests in FILE instead of
                0161      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
                0162      debugging `configure'.
                0163 
                0164 `--help'
                0165      Print a summary of the options to `configure', and exit.
                0166 
                0167 `--quiet'
                0168 `--silent'
                0169 `-q'
                0170      Do not print messages saying which checks are being made.  To
                0171      suppress all normal output, redirect it to `/dev/null' (any error
                0172      messages will still be shown).
                0173 
                0174 `--srcdir=DIR'
                0175      Look for the package's source code in directory DIR.  Usually
                0176      `configure' can determine that directory automatically.
                0177 
                0178 `--version'
                0179      Print the version of Autoconf used to generate the `configure'
                0180      script, and exit.
                0181 
                0182 `configure' also accepts some other, not widely useful, options.