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