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