INSTALL

   1 This is a generic INSTALL file for utilities distributions.
   2 If this package does not come with, e.g., installable documentation or
   3 data files, please ignore the references to them below.
   4
   5 To compile this package:
   6
   7 1.  Configure the package for your system.  In the directory that this
   8 file is in, type `./configure'.  If you're using `csh' on an old
   9 version of System V, you might need to type `sh configure' instead to
  10 prevent `csh' from trying to execute `configure' itself.
  11
  12 The `configure' shell script attempts to guess correct values for
  13 various system-dependent variables used during compilation, and
  14 creates the Makefile(s) (one in each subdirectory of the source
  15 directory).  In some packages it creates a C header file containing
  16 system-dependent definitions.  It also creates a file `config.status'
  17 that you can run in the future to recreate the current configuration.
  18
  19 Running `configure' takes a minute or two.  While it is running, it
  20 prints some messages that tell what it is doing.  If you don't want to
  21 see the messages, run `configure' with its standard output redirected
  22 to `/dev/null'; for example, `./configure >/dev/null'.
  23
  24 To compile the package in a different directory from the one
  25 containing the source code, you must use a version of make that
  26 supports the VPATH variable, such as GNU make.  `cd' to the directory
  27 where you want the object files and executables to go and run
  28 `configure'.  `configure' automatically checks for the source code in
  29 the directory that `configure' is in and in `..'.  If for some reason
  30 `configure' is not in the source code directory that you are
  31 configuring, then it will report that it can't find the source code.
  32 In that case, run `configure' with the option `--srcdir=DIR', where
  33 DIR is the directory that contains the source code.
  34
  35 By default, `make install' will install the package's files in
  36 /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
  37 an installation prefix other than /usr/local by giving `configure' the
  38 option `--prefix=PATH'.  Alternately, you can do so by giving a value
  39 for the `prefix' variable when you run `make', e.g.,
  40         make prefix=/usr/gnu
  41
  42 You can specify separate installation prefixes for
  43 architecture-specific files and architecture-independent files.  If
  44 you give `configure' the option `--exec_prefix=PATH' or set the
  45 `make' variable `exec_prefix' to PATH, the package will use PATH as
  46 the prefix for installing programs and libraries.  Data files and
  47 documentation will still use the regular prefix.  Normally, all files
  48 are installed using the regular prefix.
  49
  50 You can tell `configure' to figure out the configuration for your
  51 system, and record it in `config.status', without actually configuring
  52 the package (creating `Makefile's and perhaps a configuration header
  53 file).  To do this, give `configure' the `--no-create' option.  Later,
  54 you can run `./config.status' to actually configure the package.  This
  55 option is useful mainly in `Makefile' rules for updating `config.status'
  56 and `Makefile'.  You can also give `config.status' the `--recheck'
  57 option, which makes it re-run `configure' with the same arguments you
  58 used before.  This is useful if you change `configure'.
  59
  60 `configure' ignores any other arguments that you give it.
  61
  62 If your system requires unusual options for compilation or linking
  63 that `configure' doesn't know about, you can give `configure' initial
  64 values for some variables by setting them in the environment.  In
  65 Bourne-compatible shells, you can do that on the command line like
  66 this:
  67         CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
  68
  69 The `make' variables that you might want to override with environment
  70 variables when running `configure' are:
  71
  72 (For these variables, any value given in the environment overrides the
  73 value that `configure' would choose:)
  74 CC              C compiler program.
  75                 Default is `cc', or `gcc' if `gcc' is in your PATH.
  76 INSTALL         Program to use to install files.
  77                 Default is `install' if you have it, `cp' otherwise.
  78
  79 (For these variables, any value given in the environment is added to
  80 the value that `configure' chooses:)
  81 DEFS            Configuration options, in the form `-Dfoo -Dbar ...'
  82 LIBS            Libraries to link with, in the form `-lfoo -lbar ...'
  83
  84 If you need to do unusual things to compile the package, we encourage
  85 you to figure out how `configure' could check whether to do them, and
  86 mail diffs or instructions to the address given in the README so we
  87 can include them in the next release.
  88
  89 2.  Type `make' to compile the package.  If you want, you can override
  90 the `make' variables CFLAGS and LDFLAGS like this:
  91
  92         make CFLAGS=-O2 LDFLAGS=-s
  93
  94 3.  If the package comes with self-tests and you want to run them,
  95 type `make check'.  If you're not sure whether there are any, try it;
  96 if `make' responds with something like
  97         make: *** No way to make target `check'.  Stop.
  98 then the package does not come with self-tests.
  99
 100 4.  Type `make install' to install programs, data files, and
 101 documentation.
 102
 103 5.  You can remove the program binaries and object files from the
 104 source directory by typing `make clean'.  To also remove the
 105 Makefile(s), the header file containing system-dependent definitions
 106 (if the package uses one), and `config.status' (all the files that
 107 `configure' created), type `make distclean'.
 108
 109 The file `configure.in' is used as a template to create `configure' by
 110 a program called `autoconf'.  You will only need it if you want to
 111 regenerate `configure' using a newer version of `autoconf'.