bin/ksh/INSTALL

   1 $OpenBSD: INSTALL,v 1.1.1.1 1996/08/14 06:19:10 downsj Exp $
   2
   3 [This file is the generic GNU autoconf/configure installation description,
   4  see the README for pdksh specific configuration/installation information]
   5
   6    This is a generic INSTALL file for utilities distributions.
   7 If this package does not come with, e.g., installable documentation or
   8 data files, please ignore the references to them below.
   9
  10    The `configure' shell script attempts to guess correct values for
  11 various system-dependent variables used during compilation, and
  12 creates the Makefile(s) (one in each subdirectory of the source
  13 directory).  In some packages it creates a C header file containing
  14 system-dependent definitions.  It also creates a file `config.status'
  15 that you can run in the future to recreate the current configuration.
  16
  17 To compile this package:
  18
  19 1.  Configure the package for your system.
  20
  21    Normally, you just `cd' to the directory containing the package's
  22 source code and type `./configure'.  If you're using `csh' on an old
  23 version of System V, you might need to type `sh configure' instead to
  24 prevent `csh' from trying to execute `configure' itself.
  25
  26    Running `configure' takes awhile.  While it is running, it
  27 prints some messages that tell what it is doing.  If you don't want to
  28 see any messages, run `configure' with its standard output redirected
  29 to `/dev/null'; for example, `./configure >/dev/null'.
  30
  31    To compile the package in a different directory from the one
  32 containing the source code, you must use a version of `make' that
  33 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  34 directory where you want the object files and executables to go and run
  35 the `configure' script.  `configure' automatically checks for the
  36 source code in the directory that `configure' is in and in `..'.  If
  37 for some reason `configure' is not in the source code directory that
  38 you are configuring, then it will report that it can't find the source
  39 code.  In that case, run `configure' with the option `--srcdir=DIR',
  40 where DIR is the directory that contains the source code.
  41
  42    By default, `make install' will install the package's files in
  43 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  44 installation prefix other than `/usr/local' by giving `configure' the
  45 option `--prefix=PATH'.  Alternately, you can do so by consistently
  46 giving a value for the `prefix' variable when you run `make', e.g.,
  47      make prefix=/usr/gnu
  48      make prefix=/usr/gnu install
  49
  50    You can specify separate installation prefixes for
  51 architecture-specific files and architecture-independent files.  If you
  52 give `configure' the option `--exec-prefix=PATH' or set the `make'
  53 variable `exec_prefix' to PATH, the package will use PATH as the prefix
  54 for installing programs and libraries.  Data files and documentation
  55 will still use the regular prefix.  Normally, all files are installed
  56 using the same prefix.
  57
  58    Some packages pay attention to `--with-PACKAGE' options to
  59 `configure', where PACKAGE is something like `gnu-as' or `x' (for the
  60 X Window System).  They may also pay attention to `--enable-FEATURE'
  61 options, where FEATURE indicates an optional part of the package.  The
  62 README should mention any `--with-' and `--enable-' options that the
  63 package recognizes.
  64
  65    `configure' also recognizes the following options:
  66
  67 `--help'
  68      Print a summary of the options to `configure', and exit.
  69
  70 `--quiet'
  71 `--silent'
  72      Do not print messages saying which checks are being made.
  73
  74 `--verbose'
  75      Print the results of the checks.
  76
  77 `--version'
  78      Print the version of Autoconf used to generate the `configure'
  79      script, and exit.
  80
  81 `--x-includes=DIR'
  82      X include files are in DIR.
  83
  84 `--x-libraries=DIR'
  85      X library files are in DIR.
  86
  87    `configure' also accepts and ignores some other options.
  88
  89    On systems that require unusual options for compilation or linking
  90 that the package's `configure' script does not know about, you can give
  91 `configure' initial values for variables by setting them in the
  92 environment.  In Bourne-compatible shells, you can do that on the
  93 command line like this:
  94
  95      CC='gcc -traditional' LIBS=-lposix ./configure
  96
  97 On systems that have the `env' program, you can do it like this:
  98
  99      env CC='gcc -traditional' LIBS=-lposix ./configure
 100
 101    Here are the `make' variables that you might want to override with
 102 environment variables when running `configure'.
 103
 104    For these variables, any value given in the environment overrides the
 105 value that `configure' would choose:
 106
 107  - Variable: CC
 108      C compiler program.  The default is `cc'.
 109
 110  - Variable: INSTALL
 111      Program to use to install files.  The default is `install' if you
 112      have it, `cp' otherwise.
 113
 114    For these variables, any value given in the environment is added to
 115 the value that `configure' chooses:
 116
 117  - Variable: DEFS
 118      Configuration options, in the form `-Dfoo -Dbar...'.  Do not use
 119      this variable in packages that create a configuration header file.
 120
 121  - Variable: LIBS
 122      Libraries to link with, in the form `-lfoo -lbar...'.
 123
 124    If you need to do unusual things to compile the package, we encourage
 125 you to figure out how `configure' could check whether to do them, and
 126 mail diffs or instructions to the address given in the README so we
 127 can include them in the next release.
 128
 129 2.  Type `make' to compile the package.  If you want, you can override
 130 the `make' variables CFLAGS and LDFLAGS like this:
 131
 132         make CFLAGS=-O2 LDFLAGS=-s
 133
 134 3.  If the package comes with self-tests and you want to run them,
 135 type `make check'.  If you're not sure whether there are any, try it;
 136 if `make' responds with something like
 137         make: *** No way to make target `check'.  Stop.
 138 then the package does not come with self-tests.
 139
 140 4.  Type `make install' to install programs, data files, and
 141 documentation.
 142
 143 5.  You can remove the program binaries and object files from the
 144 source directory by typing `make clean'.  To also remove the
 145 Makefile(s), the header file containing system-dependent definitions
 146 (if the package uses one), and `config.status' (all the files that
 147 `configure' created), type `make distclean'.
 148
 149    The file `configure.in' is used to create `configure' by a program
 150 called `autoconf'.  You only need it if you want to regenerate
 151 `configure' using a newer version of `autoconf'.