Glossary action icon
[kdeaccessibility.git] / INSTALL
blob26aac1d0ab3989490abf5fc92369a10c017047b3
1 Basic Installation
2 ==================
4    These are generic installation instructions.
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').
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.
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'.
26 The simplest way to compile this package is:
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.
34      Running `configure' takes a while.  While running, it prints some
35      messages telling which features it is checking for.
37   2. Type `gmake' to compile the package.  Or if you're using a Linux
38      powered machine, or if make is GNU make, type `make'.  You can
39      check with make --version.  KDE requires GNU make to build, if 
40      gmake is appropriate, replace any instance below of make with gmake.
41      It will give output similar to:
42         #make --version
43         GNU Make version 3.78.1, by Richard Stallman and Roland McGrath.
44         Built for i386--freebsd4.0
45         Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
46         ...
48   3. Optionally, type `make check' to run any self-tests that come with
49      the package.
51   4. Type `make install' to install the programs and any data files and
52      documentation.
54   5. You can remove the program binaries and object files from the
55      source code directory by typing `make clean'.  To also remove the
56      files that `configure' created (so you can compile the package for
57      a different kind of computer), type `make distclean'.  There is
58      also a `make maintainer-clean' target, but that is intended mainly
59      for the package's developers.  If you use it, you may have to get
60      all sorts of other programs in order to regenerate files that came
61      with the distribution.
63 Compilers and Options
64 =====================
66    Some systems require unusual options for compilation or linking that
67 the `configure' script does not know about.  You can give `configure'
68 initial values for variables by setting them in the environment.  Using
69 a Bourne-compatible shell, you can do that on the command line like
70 this:
71      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
73 Or on systems that have the `env' program, you can do it like this:
74      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
76 Compiling For Multiple Architectures
77 ====================================
79    You can compile the package for more than one kind of computer at the
80 same time, by placing the object files for each architecture in their
81 own directory.  To do this, you must use a version of `make' that
82 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
83 directory where you want the object files and executables to go and run
84 the `configure' script.  `configure' automatically checks for the
85 source code in the directory that `configure' is in and in `..'.
87    If you have to use a `make' that does not supports the `VPATH'
88 variable, you have to compile the package for one architecture at a time
89 in the source code directory.  After you have installed the package for
90 one architecture, use `make distclean' before reconfiguring for another
91 architecture.
93 Installation Names
94 ==================
96    By default, `make install' will install the package's files in
97 `/usr/local/kde/bin', `/usr/local/kde/lib', etc.  You can specify an
98 installation prefix other than `/usr/local/kde' by giving `configure'
99 the option `--prefix=PATH'.
101    You can specify separate installation prefixes for
102 architecture-specific files and architecture-independent files.  If you
103 give `configure' the option `--exec-prefix=PATH', the package will use
104 PATH as the prefix for installing programs and libraries.
105 Documentation and other data files will still use the regular prefix.
107    If the package supports it, you can cause programs to be installed
108 with an extra prefix or suffix on their names by giving `configure' the
109 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
111 Optional Features
112 =================
114    Some packages pay attention to `--enable-FEATURE' options to
115 `configure', where FEATURE indicates an optional part of the package.
116 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
117 is something like `gnu-as' or `x' (for the X Window System).  The
118 `README' should mention any `--enable-' and `--with-' options that the
119 package recognizes.
121    For packages that use the X Window System, `configure' can usually
122 find the X include and library files automatically, but if it doesn't,
123 you can use the `configure' options `--x-includes=DIR' and
124 `--x-libraries=DIR' to specify their locations.
126 Specifying the System Type
127 ==========================
129    There may be some features `configure' can not figure out
130 automatically, but needs to determine by the type of host the package
131 will run on.  Usually `configure' can figure that out, but if it prints
132 a message saying it can not guess the host type, give it the
133 `--host=TYPE' option.  TYPE can either be a short name for the system
134 type, such as `sun4', or a canonical name with three fields:
135      CPU-COMPANY-SYSTEM
137 See the file `config.sub' for the possible values of each field.  If
138 `config.sub' isn't included in this package, then this package doesn't
139 need to know the host type.
141    If you are building compiler tools for cross-compiling, you can also
142 use the `--target=TYPE' option to select the type of system they will
143 produce code for and the `--build=TYPE' option to select the type of
144 system on which you are compiling the package.
146 Sharing Defaults
147 ================
149    If you want to set default values for `configure' scripts to share,
150 you can create a site shell script called `config.site' that gives
151 default values for variables like `CC', `cache_file', and `prefix'.
152 `configure' looks for `PREFIX/share/config.site' if it exists, then
153 `PREFIX/etc/config.site' if it exists.  Or, you can set the
154 `CONFIG_SITE' environment variable to the location of the site script.
155 A warning: not all `configure' scripts look for a site script.
157 Operation Controls
158 ==================
160    `configure' recognizes the following options to control how it
161 operates.
163 `--cache-file=FILE'
164      Use and save the results of the tests in FILE instead of
165      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
166      debugging `configure'.
168 `--help'
169      Print a summary of the options to `configure', and exit.
171 `--quiet'
172 `--silent'
173 `-q'
174      Do not print messages saying which checks are being made.
176 `--srcdir=DIR'
177      Look for the package's source code in directory DIR.  Usually
178      `configure' can determine that directory automatically.
180 `--version'
181      Print the version of Autoconf used to generate the `configure'
182      script, and exit.
184 `configure' also accepts some other, not widely useful, options.