Mercurial > pidgin
annotate INSTALL @ 31365:55e30c0eca22
Public API allowing plugins (including prpls) to get/set video capabilities where desired/appropriate. Fixes #13095.
committer: John Bailey <rekkanoryo@rekkanoryo.org>
author | jakub.adam@ktknet.cz |
---|---|
date | Sat, 08 Jan 2011 03:21:44 +0000 |
parents | 5ab7766a6c83 |
children |
rev | line source |
---|---|
0 | 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 | |
6900 | 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 | |
0 | 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 awhile. While running, it prints some | |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
35 messages telling which features it is checking for. If it finishes |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
36 successfully, it will print out of a summary of the build options. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
37 This summary will also appear in the help->about dialog. |
0 | 38 |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
39 2. Type `make' to compile the package. On some systems, you may need |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
40 to use `gmake' instead. |
0 | 41 |
42 3. Optionally, type `make check' to run any self-tests that come with | |
43 the package. | |
44 | |
45 4. Type `make install' to install the programs and any data files and | |
20731
712c4b0a4486
provide a hint about needing write access to
Luke Schierer <lschiere@pidgin.im>
parents:
6900
diff
changeset
|
46 documentation. You must have write access to the prefix you are |
712c4b0a4486
provide a hint about needing write access to
Luke Schierer <lschiere@pidgin.im>
parents:
6900
diff
changeset
|
47 installing to. See below for more details on the prefix. |
0 | 48 |
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. | |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
57 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
58 6. If you have *not* run make distclean, you can use the target |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
59 `make uninstall` to remove the files installed by `make install`. |
0 | 60 |
61 Compilers and Options | |
62 ===================== | |
63 | |
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 | |
70 | |
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 | |
73 | |
74 Compiling For Multiple Architectures | |
75 ==================================== | |
76 | |
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 `..'. | |
84 | |
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. | |
90 | |
91 Installation Names | |
92 ================== | |
93 | |
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'. | |
98 | |
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. | |
104 | |
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. | |
109 | |
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'. | |
113 | |
114 Optional Features | |
115 ================= | |
116 | |
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. | |
123 | |
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. | |
128 | |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
129 By default both the GTK+ UI (Pidgin) and the ncurses UI (Finch) will be |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
130 built, assuming that configure finds the necessary libraries and headers for |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
131 each. You can disable the GTK+ UI with `--disable-gtkui' and the ncurses UI |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
132 with `--disable-consoleui'. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
133 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
134 `--disable-screensaver' will build libpurple without support for detecting |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
135 when it should mark accounts idle based on mouse or keyboard usage. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
136 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
137 `--disable-sm' will build without support for the X session management. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
138 Doing so will remove the ability to have pidgin start up with your window |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
139 manager. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
140 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
141 `--disable-gtkspell' will remove the ability to highlight misspelled words. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
142 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
143 `--disable-gevolution' will cause the evolution integration plugin not to |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
144 compile. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
145 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
146 `--disable-gstreamer' will build without sound support. This applies to |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
147 *both* Pidgin and Finch. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
148 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
149 `--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. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
150 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
151 `--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. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
152 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
153 Optional Packages: |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
154 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
155 `--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. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
156 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
157 `--with-static-prpls' takes a list of comma separated protocols to build in statically (rather than as plugins). Use this with care. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
158 |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
159 `--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. |
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
160 |
27911
5ab7766a6c83
Add a missing space. I'm sure no one reads this but I noticed it the other day
Etan Reisner <pidgin@unreliablesource.net>
parents:
20764
diff
changeset
|
161 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' |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
162 |
0 | 163 Specifying the System Type |
164 ========================== | |
165 | |
166 There may be some features `configure' can not figure out | |
167 automatically, but needs to determine by the type of host the package | |
168 will run on. Usually `configure' can figure that out, but if it prints | |
169 a message saying it can not guess the host type, give it the | |
170 `--host=TYPE' option. TYPE can either be a short name for the system | |
171 type, such as `sun4', or a canonical name with three fields: | |
172 CPU-COMPANY-SYSTEM | |
173 | |
174 See the file `config.sub' for the possible values of each field. If | |
175 `config.sub' isn't included in this package, then this package doesn't | |
176 need to know the host type. | |
177 | |
178 If you are building compiler tools for cross-compiling, you can also | |
179 use the `--target=TYPE' option to select the type of system they will | |
180 produce code for and the `--build=TYPE' option to select the type of | |
181 system on which you are compiling the package. | |
182 | |
183 Sharing Defaults | |
184 ================ | |
185 | |
186 If you want to set default values for `configure' scripts to share, | |
187 you can create a site shell script called `config.site' that gives | |
188 default values for variables like `CC', `cache_file', and `prefix'. | |
189 `configure' looks for `PREFIX/share/config.site' if it exists, then | |
190 `PREFIX/etc/config.site' if it exists. Or, you can set the | |
191 `CONFIG_SITE' environment variable to the location of the site script. | |
192 A warning: not all `configure' scripts look for a site script. | |
193 | |
194 Operation Controls | |
195 ================== | |
196 | |
197 `configure' recognizes the following options to control how it | |
198 operates. | |
199 | |
200 `--cache-file=FILE' | |
201 Use and save the results of the tests in FILE instead of | |
202 `./config.cache'. Set FILE to `/dev/null' to disable caching, for | |
203 debugging `configure'. | |
204 | |
205 `--help' | |
206 Print a summary of the options to `configure', and exit. | |
207 | |
208 `--quiet' | |
209 `--silent' | |
210 `-q' | |
211 Do not print messages saying which checks are being made. To | |
212 suppress all normal output, redirect it to `/dev/null' (any error | |
213 messages will still be shown). | |
214 | |
215 `--srcdir=DIR' | |
216 Look for the package's source code in directory DIR. Usually | |
217 `configure' can determine that directory automatically. | |
218 | |
219 `--version' | |
220 Print the version of Autoconf used to generate the `configure' | |
221 script, and exit. | |
222 | |
20764
f46ae7e62d13
I gave up on getting the line widths correct. I also probably have at least one spelling mistake. Still, it might help some over the generic INSTALL we previously had, assuming of course anyone reads it.
Luke Schierer <lschiere@pidgin.im>
parents:
20731
diff
changeset
|
223 `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. |