| blob | 0889d57924455c8233494995d8cce12c4a546687 |
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.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'.
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 awhile. While running, it prints some
35 messages telling which features it is checking for. If it finishes
36 successfully, it will print out of a summary of the build options.
37 This summary will also appear in the help->about dialog.
39 2. Type `make' to compile the package. On some systems, you may need
40 to use `gmake' instead.
42 3. Optionally, type `make check' to run any self-tests that come with
43 the package.
45 4. Type `make install' to install the programs and any data files and
46 documentation. You must have write access to the prefix you are
47 installing to. See below for more details on the prefix.
49 5. You can remove the program binaries and object files from the
50 source code directory by typing `make clean'. To also remove the
51 files that `configure' created (so you can compile the package for
52 a different kind of computer), type `make distclean'. There is
53 also a `make maintainer-clean' target, but that is intended mainly
54 for the package's developers. If you use it, you may have to get
55 all sorts of other programs in order to regenerate files that came
56 with the distribution.
58 6. If you have *not* run make distclean, you can use the target
59 `make uninstall` to remove the files installed by `make install`.
61 Compilers and Options
62 =====================
64 Some systems require unusual options for compilation or linking that
65 the `configure' script does not know about. You can give `configure'
66 initial values for variables by setting them in the environment. Using
67 a Bourne-compatible shell, you can do that on the command line like
68 this:
69 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
71 Or on systems that have the `env' program, you can do it like this:
72 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
74 Compiling For Multiple Architectures
75 ====================================
77 You can compile the package for more than one kind of computer at the
78 same time, by placing the object files for each architecture in their
79 own directory. To do this, you must use a version of `make' that
80 supports the `VPATH' variable, such as GNU `make'. `cd' to the
81 directory where you want the object files and executables to go and run
82 the `configure' script. `configure' automatically checks for the
83 source code in the directory that `configure' is in and in `..'.
85 If you have to use a `make' that does not supports the `VPATH'
86 variable, you have to compile the package for one architecture at a time
87 in the source code directory. After you have installed the package for
88 one architecture, use `make distclean' before reconfiguring for another
89 architecture.
91 Installation Names
92 ==================
94 By default, `make install' will install the package's files in
95 `/usr/local/bin', `/usr/local/man', etc. You can specify an
96 installation prefix other than `/usr/local' by giving `configure' the
97 option `--prefix=PATH'.
99 You can specify separate installation prefixes for
100 architecture-specific files and architecture-independent files. If you
101 give `configure' the option `--exec-prefix=PATH', the package will use
102 PATH as the prefix for installing programs and libraries.
103 Documentation and other data files will still use the regular prefix.
105 In addition, if you use an unusual directory layout you can give
106 options like `--bindir=PATH' to specify different values for particular
107 kinds of files. Run `configure --help' for a list of the directories
108 you can set and what kinds of files go in them.
110 If the package supports it, you can cause programs to be installed
111 with an extra prefix or suffix on their names by giving `configure' the
112 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
114 Optional Features
115 =================
117 Some packages pay attention to `--enable-FEATURE' options to
118 `configure', where FEATURE indicates an optional part of the package.
119 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
120 is something like `gnu-as' or `x' (for the X Window System). The
121 `README' should mention any `--enable-' and `--with-' options that the
122 package recognizes.
124 For packages that use the X Window System, `configure' can usually
125 find the X include and library files automatically, but if it doesn't,
126 you can use the `configure' options `--x-includes=DIR' and
127 `--x-libraries=DIR' to specify their locations.
129 By default both the GTK+ UI (Pidgin) and the ncurses UI (Finch) will be
130 built, assuming that configure finds the necessary libraries and headers for
131 each. You can disable the GTK+ UI with `--disable-gtkui' and the ncurses UI
132 with `--disable-consoleui'.
134 `--disable-screensaver' will build libpurple without support for detecting
135 when it should mark accounts idle based on mouse or keyboard usage.
137 `--disable-sm' will build without support for the X session management.
138 Doing so will remove the ability to have pidgin start up with your window
139 manager.
141 `--disable-gevolution' will cause the evolution integration plugin not to
142 compile.
144 `--disable-gstreamer' will build without sound support. This applies to
145 *both* Pidgin and Finch.
147 `--enable-gnutls=yes,no' will enable or disable the use of gnutls for ssl support. Disabling both gnutls and nss will mean you cannot use either MSN or Google Talk. There is no static option for gnutls at this time.
149 `--enable-nss=yes,no,static' will enable or disable the use of nss for ssl support. This is the only option for ssl support if you are attempting to compile a static version of Pidgin or Finch.
151 Optional Packages:
153 `--with-silc-includes=DIR' and `--with-silc-libs=DIR' can be used if your silc libraries are installed to a location not in your path.
155 `--with-static-prpls' takes a list of comma separated protocols to build in statically (rather than as plugins). Use this with care.
157 `--with-dynamic-prpls' takes a list of comma separated protocols also. If used only those listed will be built. If no protocols are listed with either `--with-static-prpls' or with `--with-dynamic-prpls' then Pidgin and Finch will be effectively useless.
159 If configure does not find python, it will build without DBUS support. This will disable scripts such as purple-remote and purple-uri-handler, effectively disabling integration with the browser. You can tell configure where your python binary is located with `--with-python=PATH'
161 Specifying the System Type
162 ==========================
164 There may be some features `configure' can not figure out
165 automatically, but needs to determine by the type of host the package
166 will run on. Usually `configure' can figure that out, but if it prints
167 a message saying it can not guess the host type, give it the
168 `--host=TYPE' option. TYPE can either be a short name for the system
169 type, such as `sun4', or a canonical name with three fields:
170 CPU-COMPANY-SYSTEM
172 See the file `config.sub' for the possible values of each field. If
173 `config.sub' isn't included in this package, then this package doesn't
174 need to know the host type.
176 If you are building compiler tools for cross-compiling, you can also
177 use the `--target=TYPE' option to select the type of system they will
178 produce code for and the `--build=TYPE' option to select the type of
179 system on which you are compiling the package.
181 Sharing Defaults
182 ================
184 If you want to set default values for `configure' scripts to share,
185 you can create a site shell script called `config.site' that gives
186 default values for variables like `CC', `cache_file', and `prefix'.
187 `configure' looks for `PREFIX/share/config.site' if it exists, then
188 `PREFIX/etc/config.site' if it exists. Or, you can set the
189 `CONFIG_SITE' environment variable to the location of the site script.
190 A warning: not all `configure' scripts look for a site script.
192 Operation Controls
193 ==================
195 `configure' recognizes the following options to control how it
196 operates.
198 `--cache-file=FILE'
199 Use and save the results of the tests in FILE instead of
200 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
201 debugging `configure'.
203 `--help'
204 Print a summary of the options to `configure', and exit.
206 `--quiet'
207 `--silent'
208 `-q'
209 Do not print messages saying which checks are being made. To
210 suppress all normal output, redirect it to `/dev/null' (any error
211 messages will still be shown).
213 `--srcdir=DIR'
214 Look for the package's source code in directory DIR. Usually
215 `configure' can determine that directory automatically.
217 `--version'
218 Print the version of Autoconf used to generate the `configure'
219 script, and exit.
221 `configure' also accepts some other, not widely useful, options. Many of these are related to having various optional libaries installed to locations outside of your path.