Mercurial > hg
annotate mcabber/INSTALL @ 957:82aaa7afbd03
Cosmetic changes
author | Mikael Berthe <mikael@lilotux.net> |
---|---|
date | Sat, 02 Sep 2006 14:59:37 +0200 |
parents | a09bf67d1dfb |
children | da696ed4acf4 |
rev | line source |
---|---|
232 | 1 This file contains the generic instructions; the short version is: |
2 $ ./configure | |
3 $ make | |
4 ... and if you want to install the software: | |
5 $ make install | |
6 (If you don't want to install it, the "mcabber" binary lies in | |
7 the src/ directory after the build procedure) | |
8 | |
9 MCabber needs ncurses and ncurses development packages to build correctly. | |
934
a09bf67d1dfb
Unicode support depends on having ncursesw
Mikael Berthe <mikael@lilotux.net>
parents:
232
diff
changeset
|
10 For UTF-8 terminal support, use ncursesw instead. |
232 | 11 If you want SSL support, you will need openssl lib & dev packages as well. |
12 | |
13 Please have a look at the README file before launching mcabber. | |
14 | |
15 Please send me a message (mcabber AT lilotux DOT net) if you have | |
16 questions, suggestions or even patches... | |
17 | |
18 Mikael | |
19 | |
20 | |
57 | 21 Installation Instructions |
22 ************************* | |
23 | |
24 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free | |
25 Software Foundation, Inc. | |
26 | |
27 This file is free documentation; the Free Software Foundation gives | |
28 unlimited permission to copy, distribute and modify it. | |
29 | |
30 Basic Installation | |
31 ================== | |
32 | |
33 These are generic installation instructions. | |
34 | |
35 The `configure' shell script attempts to guess correct values for | |
36 various system-dependent variables used during compilation. It uses | |
37 those values to create a `Makefile' in each directory of the package. | |
38 It may also create one or more `.h' files containing system-dependent | |
39 definitions. Finally, it creates a shell script `config.status' that | |
40 you can run in the future to recreate the current configuration, and a | |
41 file `config.log' containing compiler output (useful mainly for | |
42 debugging `configure'). | |
43 | |
44 It can also use an optional file (typically called `config.cache' | |
45 and enabled with `--cache-file=config.cache' or simply `-C') that saves | |
46 the results of its tests to speed up reconfiguring. (Caching is | |
47 disabled by default to prevent problems with accidental use of stale | |
48 cache files.) | |
49 | |
50 If you need to do unusual things to compile the package, please try | |
51 to figure out how `configure' could check whether to do them, and mail | |
52 diffs or instructions to the address given in the `README' so they can | |
53 be considered for the next release. If you are using the cache, and at | |
54 some point `config.cache' contains results you don't want to keep, you | |
55 may remove or edit it. | |
56 | |
57 The file `configure.ac' (or `configure.in') is used to create | |
58 `configure' by a program called `autoconf'. You only need | |
59 `configure.ac' if you want to change it or regenerate `configure' using | |
60 a newer version of `autoconf'. | |
61 | |
62 The simplest way to compile this package is: | |
63 | |
64 1. `cd' to the directory containing the package's source code and type | |
65 `./configure' to configure the package for your system. If you're | |
66 using `csh' on an old version of System V, you might need to type | |
67 `sh ./configure' instead to prevent `csh' from trying to execute | |
68 `configure' itself. | |
69 | |
70 Running `configure' takes awhile. While running, it prints some | |
71 messages telling which features it is checking for. | |
72 | |
73 2. Type `make' to compile the package. | |
74 | |
75 3. Optionally, type `make check' to run any self-tests that come with | |
76 the package. | |
77 | |
78 4. Type `make install' to install the programs and any data files and | |
79 documentation. | |
80 | |
81 5. You can remove the program binaries and object files from the | |
82 source code directory by typing `make clean'. To also remove the | |
83 files that `configure' created (so you can compile the package for | |
84 a different kind of computer), type `make distclean'. There is | |
85 also a `make maintainer-clean' target, but that is intended mainly | |
86 for the package's developers. If you use it, you may have to get | |
87 all sorts of other programs in order to regenerate files that came | |
88 with the distribution. | |
89 | |
90 Compilers and Options | |
91 ===================== | |
92 | |
93 Some systems require unusual options for compilation or linking that the | |
94 `configure' script does not know about. Run `./configure --help' for | |
95 details on some of the pertinent environment variables. | |
96 | |
97 You can give `configure' initial values for configuration parameters | |
98 by setting variables in the command line or in the environment. Here | |
99 is an example: | |
100 | |
101 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix | |
102 | |
103 *Note Defining Variables::, for more details. | |
104 | |
105 Compiling For Multiple Architectures | |
106 ==================================== | |
107 | |
108 You can compile the package for more than one kind of computer at the | |
109 same time, by placing the object files for each architecture in their | |
110 own directory. To do this, you must use a version of `make' that | |
111 supports the `VPATH' variable, such as GNU `make'. `cd' to the | |
112 directory where you want the object files and executables to go and run | |
113 the `configure' script. `configure' automatically checks for the | |
114 source code in the directory that `configure' is in and in `..'. | |
115 | |
116 If you have to use a `make' that does not support the `VPATH' | |
117 variable, you have to compile the package for one architecture at a | |
118 time in the source code directory. After you have installed the | |
119 package for one architecture, use `make distclean' before reconfiguring | |
120 for another architecture. | |
121 | |
122 Installation Names | |
123 ================== | |
124 | |
125 By default, `make install' will install the package's files in | |
126 `/usr/local/bin', `/usr/local/man', etc. You can specify an | |
127 installation prefix other than `/usr/local' by giving `configure' the | |
128 option `--prefix=PREFIX'. | |
129 | |
130 You can specify separate installation prefixes for | |
131 architecture-specific files and architecture-independent files. If you | |
132 give `configure' the option `--exec-prefix=PREFIX', the package will | |
133 use PREFIX as the prefix for installing programs and libraries. | |
134 Documentation and other data files will still use the regular prefix. | |
135 | |
136 In addition, if you use an unusual directory layout you can give | |
137 options like `--bindir=DIR' to specify different values for particular | |
138 kinds of files. Run `configure --help' for a list of the directories | |
139 you can set and what kinds of files go in them. | |
140 | |
141 If the package supports it, you can cause programs to be installed | |
142 with an extra prefix or suffix on their names by giving `configure' the | |
143 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | |
144 | |
145 Optional Features | |
146 ================= | |
147 | |
148 Some packages pay attention to `--enable-FEATURE' options to | |
149 `configure', where FEATURE indicates an optional part of the package. | |
150 They may also pay attention to `--with-PACKAGE' options, where PACKAGE | |
151 is something like `gnu-as' or `x' (for the X Window System). The | |
152 `README' should mention any `--enable-' and `--with-' options that the | |
153 package recognizes. | |
154 | |
155 For packages that use the X Window System, `configure' can usually | |
156 find the X include and library files automatically, but if it doesn't, | |
157 you can use the `configure' options `--x-includes=DIR' and | |
158 `--x-libraries=DIR' to specify their locations. | |
159 | |
160 Specifying the System Type | |
161 ========================== | |
162 | |
163 There may be some features `configure' cannot figure out automatically, | |
164 but needs to determine by the type of machine the package will run on. | |
165 Usually, assuming the package is built to be run on the _same_ | |
166 architectures, `configure' can figure that out, but if it prints a | |
167 message saying it cannot guess the machine type, give it the | |
168 `--build=TYPE' option. TYPE can either be a short name for the system | |
169 type, such as `sun4', or a canonical name which has the form: | |
170 | |
171 CPU-COMPANY-SYSTEM | |
172 | |
173 where SYSTEM can have one of these forms: | |
174 | |
175 OS KERNEL-OS | |
176 | |
177 See the file `config.sub' for the possible values of each field. If | |
178 `config.sub' isn't included in this package, then this package doesn't | |
179 need to know the machine type. | |
180 | |
181 If you are _building_ compiler tools for cross-compiling, you should | |
182 use the `--target=TYPE' option to select the type of system they will | |
183 produce code for. | |
184 | |
185 If you want to _use_ a cross compiler, that generates code for a | |
186 platform different from the build platform, you should specify the | |
187 "host" platform (i.e., that on which the generated programs will | |
188 eventually be run) with `--host=TYPE'. | |
189 | |
190 Sharing Defaults | |
191 ================ | |
192 | |
193 If you want to set default values for `configure' scripts to share, you | |
194 can create a site shell script called `config.site' that gives default | |
195 values for variables like `CC', `cache_file', and `prefix'. | |
196 `configure' looks for `PREFIX/share/config.site' if it exists, then | |
197 `PREFIX/etc/config.site' if it exists. Or, you can set the | |
198 `CONFIG_SITE' environment variable to the location of the site script. | |
199 A warning: not all `configure' scripts look for a site script. | |
200 | |
201 Defining Variables | |
202 ================== | |
203 | |
204 Variables not defined in a site shell script can be set in the | |
205 environment passed to `configure'. However, some packages may run | |
206 configure again during the build, and the customized values of these | |
207 variables may be lost. In order to avoid this problem, you should set | |
208 them in the `configure' command line, using `VAR=value'. For example: | |
209 | |
210 ./configure CC=/usr/local2/bin/gcc | |
211 | |
212 causes the specified `gcc' to be used as the C compiler (unless it is | |
213 overridden in the site shell script). Here is a another example: | |
214 | |
215 /bin/bash ./configure CONFIG_SHELL=/bin/bash | |
216 | |
217 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent | |
218 configuration-related scripts to be executed by `/bin/bash'. | |
219 | |
220 `configure' Invocation | |
221 ====================== | |
222 | |
223 `configure' recognizes the following options to control how it operates. | |
224 | |
225 `--help' | |
226 `-h' | |
227 Print a summary of the options to `configure', and exit. | |
228 | |
229 `--version' | |
230 `-V' | |
231 Print the version of Autoconf used to generate the `configure' | |
232 script, and exit. | |
233 | |
234 `--cache-file=FILE' | |
235 Enable the cache: use and save the results of the tests in FILE, | |
236 traditionally `config.cache'. FILE defaults to `/dev/null' to | |
237 disable caching. | |
238 | |
239 `--config-cache' | |
240 `-C' | |
241 Alias for `--cache-file=config.cache'. | |
242 | |
243 `--quiet' | |
244 `--silent' | |
245 `-q' | |
246 Do not print messages saying which checks are being made. To | |
247 suppress all normal output, redirect it to `/dev/null' (any error | |
248 messages will still be shown). | |
249 | |
250 `--srcdir=DIR' | |
251 Look for the package's source code in directory DIR. Usually | |
252 `configure' can determine that directory automatically. | |
253 | |
254 `configure' also accepts some other, not widely useful, options. Run | |
255 `configure --help' for more details. | |
256 |