* updating info inside INSTALL
[kdevelop:kdevelop.git] / INSTALL
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.in' is used to create `configure' by a program
23 called `autoconf'.  You only need `configure.in' 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 a while.  While running, it prints some
35      messages telling which features it is checking for.
36
37      Please also have a look in the section "KDevelop Specific Controls"
38      below.
39
40   2. Type `make' to compile the package.
41
42   3. Type `make install' to install the programs and any data files and
43      documentation.
44
45   4. You can remove the program binaries and object files from the
46      source code directory by typing `make clean'.  
47
48 Compilers and Options
49 =====================
50
51    Some systems require unusual options for compilation or linking that
52 the `configure' script does not know about.  You can give `configure'
53 initial values for variables by setting them in the environment.  Using
54 a Bourne-compatible shell, you can do that on the command line like
55 this:
56      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
57
58 Or on systems that have the `env' program, you can do it like this:
59      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
60
61 Compiling For Multiple Architectures
62 ====================================
63
64    You can compile the package for more than one kind of computer at the
65 same time, by placing the object files for each architecture in their
66 own directory.  To do this, you must use a version of `make' that
67 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
68 directory where you want the object files and executables to go and run
69 the `configure' script.  `configure' automatically checks for the
70 source code in the directory that `configure' is in and in `..'.
71
72    If you have to use a `make' that does not supports the `VPATH'
73 variable, you have to compile the package for one architecture at a time
74 in the source code directory.  After you have installed the package for
75 one architecture, use `make distclean' before reconfiguring for another
76 architecture.
77
78 Installation Names
79 ==================
80
81    By default, `make install' will install the package's files in
82 `/opt/kde/bin', `/opt/kde/man', etc.  You can specify an
83 installation prefix other than `/opt/kde/' by giving `configure' the
84 option `--prefix=PATH'.
85
86    You can specify separate installation prefixes for
87 architecture-specific files and architecture-independent files.  If you
88 give `configure' the option `--exec-prefix=PATH', the package will use
89 PATH as the prefix for installing programs and libraries.
90 Documentation and other data files will still use the regular prefix.
91
92    If the package supports it, you can cause programs to be installed
93 with an extra prefix or suffix on their names by giving `configure' the
94 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
95
96 Optional Features
97 =================
98
99    Some packages pay attention to `--enable-FEATURE' options to
100 `configure', where FEATURE indicates an optional part of the package.
101 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
102 is something like `gnu-as' or `x' (for the X Window System).  The
103 `README' should mention any `--enable-' and `--with-' options that the
104 package recognizes.
105
106    For packages that use the X Window System, `configure' can usually
107 find the X include and library files automatically, but if it doesn't,
108 you can use the `configure' options `--x-includes=DIR' and
109 `--x-libraries=DIR' to specify their locations.
110
111 Specifying the System Type
112 ==========================
113
114    There may be some features `configure' can not figure out
115 automatically, but needs to determine by the type of host the package
116 will run on.  Usually `configure' can figure that out, but if it prints
117 a message saying it can not guess the host type, give it the
118 `--host=TYPE' option.  TYPE can either be a short name for the system
119 type, such as `sun4', or a canonical name with three fields:
120      CPU-COMPANY-SYSTEM
121
122 See the file `config.sub' for the possible values of each field.  If
123 `config.sub' isn't included in this package, then this package doesn't
124 need to know the host type.
125
126    If you are building compiler tools for cross-compiling, you can also
127 use the `--target=TYPE' option to select the type of system they will
128 produce code for and the `--build=TYPE' option to select the type of
129 system on which you are compiling the package.
130
131 Sharing Defaults
132 ================
133
134    If you want to set default values for `configure' scripts to share,
135 you can create a site shell script called `config.site' that gives
136 default values for variables like `CC', `cache_file', and `prefix'.
137 `configure' looks for `PREFIX/share/config.site' if it exists, then
138 `PREFIX/etc/config.site' if it exists.  Or, you can set the
139 `CONFIG_SITE' environment variable to the location of the site script.
140 A warning: not all `configure' scripts look for a site script.
141
142 Operation Controls
143 ==================
144
145    `configure' recognizes the following options to control how it
146 operates.
147
148 `--cache-file=FILE'
149      Use and save the results of the tests in FILE instead of
150      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
151      debugging `configure'.
152
153 `--help'
154      Print a summary of the options to `configure', and exit.
155
156 `--quiet'
157 `--silent'
158 `-q'
159      Do not print messages saying which checks are being made.
160
161 `--srcdir=DIR'
162      Look for the package's source code in directory DIR.  Usually
163      `configure' can determine that directory automatically.
164
165 `--version'
166      Print the version of Autoconf used to generate the `configure'
167      script, and exit.
168
169 KDevelop Specific Controls
170 ==========================
171
172 `--with-qtdoc-dir=DIR'
173     Defines where the Qt documentation is installed.
174     This switch overrides the automatic directory determination.
175
176 `--with-kdelibsdoc-dir=DIR'   where the kdelibs documentation is installed
177     Defines where the KDE library documentation is installed.
178     This switch overrides the automatic directory determination.
179
180 `--with-kdocindex-dir=DIR'
181     This switch is obsolete... do not use it!
182     Index files are always searched under kdelibsdoc-dir/kdoc-reference
183
184 `--enable-docbase'
185     This enables Debian docbase support. [default=disabled]
186
187 `--disable-kdoc2'
188     This disables kdoc2 support. You need to use this switch if your
189     system uses a kdoc 1.x version. [default=enabled]
190
191 `--enable-cpp-reparse'
192     This enables the class parsing behaviour of KDevelop.
193     If you use this switch KDevelop does reparsing of all classes also on
194     saving c/c++-sources. [default=disabled] this means only reparsing on
195     saving include-files.
196
197 `configure' also accepts some other, not widely useful, options.
198