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