05e00f71cb742fb8bc632d341f60d7fe429989a6
[asterisk/asterisk.git] / main / editline / INSTALL
1 Building this distribution in many cases is as simple as typing the following
2 while in the root directory of the source tree:
3
4         ./configure
5         make
6
7 To install, do the above, then type:
8
9         make install
10
11 Additional build targets of finer granularity include:
12
13         lib_a
14         lib_s
15         install_hdr
16         install_lib
17         install_lib_a
18         install_lib_s
19         install_man
20         test
21
22 Cleanup targets include:
23
24         clean
25         distclean
26
27 Optionally, pass any of the following (not a definitive list) arguments to
28 'configure':
29
30 --prefix=<install-root-dir>
31         Set the base directory in which to install.  For example:
32
33                 ./configure --prefix=/usr/local
34
35         will cause files to be installed into /usr/local/bin, /usr/local/man,
36         /usr/local/include, /usr/local/lib, and /usr/local/share.
37
38 --disable-readline
39         By default, libedit is built and installed such that it works as a
40         drop-in replacement for the readline library.  This option turns that
41         behavior off.
42
43 --enable-debug
44         Build debugging code (for libedit development).
45
46 Optionally, define environment variables, including (not exclusively):
47
48 CFLAGS="?"
49         Pass these flags to the compiler.  You probably shouldn't define this
50         unless you know what you are doing.
51
52 CPPFLAGS="?"
53         Pass these flags to the C preprocessor.  Note that CFLAGS is not passed
54         to 'cpp' when 'configure' is looking for include files, so you must use
55         CPPFLAGS instead if you need to help 'configure' find header files.
56
57 LD_LIBRARY_PATH="?"
58         'ld' uses this colon-separated list to find libraries.
59
60 LDFLAGS="?"
61         Flags passed to 'gcc', which should normally be passed on to 'ld'.
62
63 PATH="?"
64         'configure' uses this to find programs.