Annotation of embedaddon/libiconv/INSTALL.generic, revision 1.1.1.1
1.1 misho 1: Basic Installation
2: ==================
3:
4: These are generic installation instructions.
5:
6: The `configure' shell script attempts to guess correct values for
7: various system-dependent variables used during compilation. It uses
8: those values to create a `Makefile' in each directory of the package.
9: It may also create one or more `.h' files containing system-dependent
10: definitions. Finally, it creates a shell script `config.status' that
11: you can run in the future to recreate the current configuration, a file
12: `config.cache' that saves the results of its tests to speed up
13: reconfiguring, and a file `config.log' containing compiler output
14: (useful mainly for debugging `configure').
15:
16: If you need to do unusual things to compile the package, please try
17: to figure out how `configure' could check whether to do them, and mail
18: diffs or instructions to the address given in the `README' so they can
19: be considered for the next release. If at some point `config.cache'
20: contains results you don't want to keep, you may remove or edit it.
21:
22: The file `configure.ac' is used to create `configure' by a program
23: called `autoconf'. You only need `configure.ac' if you want to change
24: it or regenerate `configure' using a newer version of `autoconf'.
25:
26: The simplest way to compile this package is:
27:
28: 1. `cd' to the directory containing the package's source code and type
29: `./configure' to configure the package for your system. If you're
30: using `csh' on an old version of System V, you might need to type
31: `sh ./configure' instead to prevent `csh' from trying to execute
32: `configure' itself.
33:
34: Running `configure' takes awhile. While running, it prints some
35: messages telling which features it is checking for.
36:
37: 2. Type `make' to compile the package.
38:
39: 3. Optionally, type `make check' to run any self-tests that come with
40: the package.
41:
42: 4. Type `make install' to install the programs and any data files and
43: documentation.
44:
45: 5. You can remove the program binaries and object files from the
46: source code directory by typing `make clean'. To also remove the
47: files that `configure' created (so you can compile the package for
48: a different kind of computer), type `make distclean'. There is
49: also a `make maintainer-clean' target, but that is intended mainly
50: for the package's developers. If you use it, you may have to get
51: all sorts of other programs in order to regenerate files that came
52: with the distribution.
53:
54: Compilers and Options
55: =====================
56:
57: Some systems require unusual options for compilation or linking that
58: the `configure' script does not know about. You can give `configure'
59: initial values for variables by setting them in the environment. Using
60: a Bourne-compatible shell, you can do that on the command line like
61: this:
62: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
63:
64: Or on systems that have the `env' program, you can do it like this:
65: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
66:
67: Compiling For Multiple Architectures
68: ====================================
69:
70: You can compile the package for more than one kind of computer at the
71: same time, by placing the object files for each architecture in their
72: own directory. To do this, you must use a version of `make' that
73: supports the `VPATH' variable, such as GNU `make'. `cd' to the
74: directory where you want the object files and executables to go and run
75: the `configure' script. `configure' automatically checks for the
76: source code in the directory that `configure' is in and in `..'.
77:
78: If you have to use a `make' that does not supports the `VPATH'
79: variable, you have to compile the package for one architecture at a time
80: in the source code directory. After you have installed the package for
81: one architecture, use `make distclean' before reconfiguring for another
82: architecture.
83:
84: On MacOS X 10.5 and later systems, you can create libraries and
85: executables that work on multiple system types--known as "fat" or
86: "universal" binaries--by specifying multiple '-arch' options to the
87: compiler but only a single '-arch' option to the preprocessor. Like
88: this:
89:
90: ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
91: CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
92: CPP="gcc -E" CXXCPP="g++ -E"
93:
94: This is not guaranteed to produce working output in all cases. You
95: may have to build one architecture at a time and combine the results
96: using the 'lipo' tool if you have problems.
97:
98: Installation Names
99: ==================
100:
101: By default, `make install' will install the package's files in
102: `/usr/local/bin', `/usr/local/man', etc. You can specify an
103: installation prefix other than `/usr/local' by giving `configure' the
104: option `--prefix=PATH'.
105:
106: You can specify separate installation prefixes for
107: architecture-specific files and architecture-independent files. If you
108: give `configure' the option `--exec-prefix=PATH', the package will use
109: PATH as the prefix for installing programs and libraries.
110: Documentation and other data files will still use the regular prefix.
111:
112: In addition, if you use an unusual directory layout you can give
113: options like `--bindir=PATH' to specify different values for particular
114: kinds of files. Run `configure --help' for a list of the directories
115: you can set and what kinds of files go in them.
116:
117: If the package supports it, you can cause programs to be installed
118: with an extra prefix or suffix on their names by giving `configure' the
119: option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
120:
121: Relocatable Installation
122: ========================
123:
124: By default, `make install' will install a package with hardwired
125: file names, and the package will not work correctly when copied or
126: moved to a different location in the filesystem.
127:
128: Some packages pay attention to the `--enable-relocatable' option to
129: `configure'. This option makes the entire installed package
130: relocatable. This means, it can be moved or copied to a different
131: location on the filesystem. It is possible to make symlinks to the
132: installed and moved programs, and invoke them through the symlink. It
133: is possible to do the same thing with a hard link _only_ if the hard
134: linked file is in the same directory as the real program.
135:
136: For reliability it is best to give together with --enable-relocatable
137: a `--prefix' option pointing to an otherwise unused (and never used
138: again) directory, for example, `--prefix=/tmp/inst$$'. This is
139: recommended because on some OSes the executables remember the location
140: of shared libraries (and prefer them over LD_LIBRARY_PATH !), therefore
141: such an executable will look for its shared libraries first in the
142: original installation directory and only then in the current
143: installation directory.
144:
145: Installation with `--enable-relocatable' will not work for setuid /
146: setgid executables. (This is because such an executable kills its
147: LD_LIBRARY_PATH variable when it is launched.)
148:
149: The runtime penalty and size penalty are nearly zero on Linux 2.2 or
150: newer (just one system call more when an executable is launched), and
151: small on other systems (the wrapper program just sets an environment
152: variable and execs the real program).
153:
154: Optional Features
155: =================
156:
157: Some packages pay attention to `--enable-FEATURE' options to
158: `configure', where FEATURE indicates an optional part of the package.
159: They may also pay attention to `--with-PACKAGE' options, where PACKAGE
160: is something like `gnu-as' or `x' (for the X Window System). The
161: `README' should mention any `--enable-' and `--with-' options that the
162: package recognizes.
163:
164: For packages that use the X Window System, `configure' can usually
165: find the X include and library files automatically, but if it doesn't,
166: you can use the `configure' options `--x-includes=DIR' and
167: `--x-libraries=DIR' to specify their locations.
168:
169: For packages that use the GNU libiconv library, you can use the
170: `configure' option `--with-libiconv-prefix' to specify the prefix you
171: used while installing GNU libiconv. This option is not necessary if
172: that other prefix is the same as the one now specified through --prefix.
173:
174: For packages that use the GNU libintl library, you can use the
175: `configure' option `--with-libintl-prefix' to specify the prefix you
176: used while installing GNU gettext-runtime. This option is not necessary if
177: that other prefix is the same as the one now specified through --prefix.
178:
179: Particular Systems
180: ==================
181:
182: On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC
183: is not installed, it is recommended to use the following options in order
184: to use an ANSI C compiler:
185:
186: ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
187:
188: and if that doesn't work, install pre-built binaries of GCC for HP-UX.
189:
190: On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
191: parse its `<wchar.h>' header file. The option `-nodtk' can be used as
192: a workaround. If GNU CC is not installed, it is therefore recommended
193: to try
194:
195: ./configure CC="cc"
196:
197: and if that doesn't work, try
198:
199: ./configure CC="cc -nodtk"
200:
201: On AIX 3, the C include files by default don't define some necessary
202: prototype declarations. If GNU CC is not installed, it is recommended to
203: use the following options:
204:
205: ./configure CC="xlc -D_ALL_SOURCE"
206:
207: On BeOS, user installed software goes in /boot/home/config, not
208: /usr/local. It is recommended to use the following options:
209:
210: ./configure --prefix=/boot/home/config
211:
212: Specifying the System Type
213: ==========================
214:
215: There may be some features `configure' can not figure out
216: automatically, but needs to determine by the type of host the package
217: will run on. Usually `configure' can figure that out, but if it prints
218: a message saying it can not guess the host type, give it the
219: `--host=TYPE' option. TYPE can either be a short name for the system
220: type, such as `sun4', or a canonical name with three fields:
221: CPU-COMPANY-SYSTEM
222:
223: See the file `config.sub' for the possible values of each field. If
224: `config.sub' isn't included in this package, then this package doesn't
225: need to know the host type.
226:
227: If you are building compiler tools for cross-compiling, you can also
228: use the `--target=TYPE' option to select the type of system they will
229: produce code for and the `--build=TYPE' option to select the type of
230: system on which you are compiling the package.
231:
232: Sharing Defaults
233: ================
234:
235: If you want to set default values for `configure' scripts to share,
236: you can create a site shell script called `config.site' that gives
237: default values for variables like `CC', `cache_file', and `prefix'.
238: `configure' looks for `PREFIX/share/config.site' if it exists, then
239: `PREFIX/etc/config.site' if it exists. Or, you can set the
240: `CONFIG_SITE' environment variable to the location of the site script.
241: A warning: not all `configure' scripts look for a site script.
242:
243: Operation Controls
244: ==================
245:
246: `configure' recognizes the following options to control how it
247: operates.
248:
249: `--cache-file=FILE'
250: Use and save the results of the tests in FILE instead of
251: `./config.cache'. Set FILE to `/dev/null' to disable caching, for
252: debugging `configure'.
253:
254: `--help'
255: Print a summary of the options to `configure', and exit.
256:
257: `--quiet'
258: `--silent'
259: `-q'
260: Do not print messages saying which checks are being made. To
261: suppress all normal output, redirect it to `/dev/null' (any error
262: messages will still be shown).
263:
264: `--srcdir=DIR'
265: Look for the package's source code in directory DIR. Usually
266: `configure' can determine that directory automatically.
267:
268: `--version'
269: Print the version of Autoconf used to generate the `configure'
270: script, and exit.
271:
272: `configure' also accepts some other, not widely useful, options.
273:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>