Commit | Line | Data |
---|---|---|
1cf13934 JS |
1 | wxWindows 2.3 for X11 installation |
2 | ------------------------------------ | |
3 | ||
4 | IMPORTANT NOTE: | |
5 | ||
6 | If you experience problems installing, please re-read these | |
7 | instructions and other related files (todo.txt, bugs.txt and | |
8 | osname.txt for your platform if it exists) carefully before | |
9 | mailing wxwin-users or the author. Preferably, try to fix the | |
10 | problem first and then send a patch to the author. | |
11 | ||
12 | When sending bug reports tell us what version of wxWindows you are | |
13 | using (including the beta) and what compiler on what system. One | |
14 | example: wxX11 2.3.0, egcs 1.1.1, Redhat 5.0 | |
15 | ||
16 | First steps | |
17 | ----------- | |
18 | ||
868741e9 | 19 | - Download wxWindows-X-x.y.z.tgz, where x.y.z is the version number. |
1cf13934 JS |
20 | Download documentation in a preferred format, such as |
21 | wxWindows-HTML.zip or wxWindows-PDF.zip. | |
22 | ||
23 | - Make a directory such as ~/wx and unarchive the files into this | |
24 | directory. | |
25 | ||
26 | - It is recommended that you install bison and flex; using yacc | |
27 | and lex may require tweaking of the makefiles. You also need | |
28 | libXpm if you want to have XPM support in wxWindows (recommended). | |
29 | ||
30 | - You can now use configure to build wxWindows and the samples. | |
31 | ||
32 | Using configure is the recommended way to build the library. If it doesn't | |
33 | work for you for whatever reason, please report it (together with detailed | |
34 | information about your platform and the (relevant part of) contents of | |
35 | config.log file) to wx-dev@lists.wxwindows.org. | |
36 | ||
37 | COMPILING USING CONFIGURE | |
38 | ========================= | |
39 | ||
40 | * The most simple case | |
41 | ----------------------- | |
42 | ||
43 | If you compile wxWindows on Linux for the first time and don't like to read | |
44 | install instructions just do (in the base dir): | |
45 | ||
ea596687 | 46 | > ./configure --with-x11 |
1cf13934 JS |
47 | > make |
48 | > su <type root password> | |
49 | > make install | |
50 | > ldconfig | |
51 | > exit | |
52 | ||
53 | Afterwards you can continue with | |
54 | ||
55 | > make | |
56 | > su <type root password> | |
57 | > make install | |
58 | > ldconfig | |
59 | > exit | |
60 | ||
61 | If you want to remove wxWindows on Unix you can do this: | |
62 | ||
63 | > su <type root password> | |
64 | > make uninstall | |
65 | > ldconfig | |
66 | > exit | |
67 | ||
68 | * The expert case | |
69 | ----------------- | |
70 | ||
71 | If you want to do some more serious cross-platform programming with wxWindows, | |
72 | such as for GTK and X11, you can now build two complete libraries and use | |
2edb0bde | 73 | them concurrently. For this end, you have to create a directory for each build |
1cf13934 JS |
74 | of wxWindows - you may also want to create different versions of wxWindows |
75 | and test them concurrently. Most typically, this would be a version configured | |
76 | with --enable-debug_flag and one without. Note, that only one build can currently | |
77 | be installed, so you'd have to use local version of the library for that purpose. | |
78 | For building three versions (one GTK, one X11 and a debug version of the GTK | |
79 | source) you'd do this: | |
80 | ||
81 | md buildx11 | |
82 | cd buildx11 | |
83 | ../configure --with-x11 --with-universal | |
84 | make | |
85 | cd .. | |
86 | ||
87 | md buildgtk | |
88 | cd buildgtk | |
89 | ../configure --with-gtk | |
90 | make | |
91 | cd .. | |
92 | ||
93 | md buildgtkd | |
94 | cd buildgtkd | |
95 | ../configure --with-gtk --enable-debug_flag | |
96 | make | |
97 | cd .. | |
98 | ||
99 | * The most simple errors | |
100 | ------------------------ | |
101 | ||
102 | You get errors during compilation: The reason is that you probably have a broken | |
103 | compiler, which includes almost everything that is called gcc. If you use gcc 2.8 | |
2edb0bde | 104 | you have to disable optimisation as the compiler will give up with an internal |
1cf13934 JS |
105 | compiler error. |
106 | ||
107 | If there is just any way for you to use egcs, use egcs. We cannot fix gcc. | |
108 | ||
109 | You get immediate segfault when starting any sample or application: This is either | |
110 | due to having compiled the library with different flags or options than your program - | |
111 | typically you might have the __WXDEBUG__ option set for the library but not for your | |
112 | program - or due to using a broken compiler (and its optimisation) such as GCC 2.8. | |
113 | ||
114 | * The most simple program | |
115 | ------------------------- | |
116 | ||
117 | Now create your super-application myfoo.app and compile anywhere with | |
118 | ||
119 | g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo | |
120 | ||
121 | * General | |
122 | ----------------------- | |
123 | ||
124 | The Unix variants of wxWindows use GNU configure. If you have problems with your | |
125 | make use GNU make instead. | |
126 | ||
127 | If you have general problems with installation, read my homepage at | |
128 | ||
129 | http://wesley.informatik.uni-freiburg.de/~wxxt | |
130 | ||
131 | for newest information. If you still don't have any success, please send a bug | |
132 | report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF | |
133 | YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF GTK, WXGTK, WHAT DISTRIBUTION | |
134 | YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried... | |
135 | ||
136 | * GUI libraries | |
137 | ----------------------- | |
138 | ||
139 | wxWindows/X11 requires the X11 library to be installed on your system. As | |
140 | an alternative, you may also use the free library "lesstif" which implements | |
141 | most of the X11 API without the licence restrictions of X11. | |
142 | ||
143 | You can get the newest version of the Lesstif from the lesstif homepage at: | |
144 | ||
145 | http://www.lesstif.org | |
146 | ||
147 | * Additional libraries | |
148 | ----------------------- | |
149 | ||
150 | wxWindows/X11 requires a thread library and X libraries known to work with threads. | |
151 | This is the case on all commercial Unix-Variants and all Linux-Versions that are | |
152 | based on glibc 2 except RedHat 5.0 which is broken in many aspects. As of writing | |
153 | this, these Linux distributions have correct glibc 2 support: | |
154 | ||
155 | - RedHat 5.1 | |
156 | - Debian 2.0 | |
157 | - Stampede | |
158 | - DLD 6.0 | |
159 | - SuSE 6.0 | |
160 | ||
161 | You can disable thread support by running | |
162 | ||
163 | ./configure "--disable-threads" | |
164 | make | |
165 | su <type root password> | |
166 | make install | |
167 | ldconfig | |
168 | exit | |
169 | ||
170 | NB: DO NOT COMPILE WXGTK WITH GCC AND THREADS, SINCE ALL PROGRAMS WILL | |
171 | CRASH UPON START-UP! Just always use egcs and be happy. | |
172 | ||
173 | * Building wxGTK on OS/2 | |
174 | -------------------------- | |
175 | ||
176 | Please send comments and question about the OS/2 installation | |
177 | to Andrea Venturoli <a.ventu@flashnet.it> and patches to | |
178 | the wxWindows mailing list. | |
179 | ||
180 | You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3 or newer), | |
181 | Lesstif (0.89.1 or newer), emx (0.9d fix 1), flex (2.5.4), | |
182 | yacc (1.8), unix like shell, e.g. korn shell (5.2.13), | |
183 | Autoconf (2.13), GNU file utilities (3.6), | |
184 | GNU text utilities (1.3), GNU shell utilites (1.12), m4 (1.4), | |
185 | sed (2.05), grep (2.0), Awk (3.0.3), GNU Make (3.76.1). | |
186 | ||
187 | Open an OS/2 prompt and switch to the directory above. | |
188 | First set some global environment variables we need: | |
189 | ||
190 | SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__ | |
191 | SET CFLAGS=-Zmtd -D__ST_MT_ERRNO__ | |
192 | SET OSTYPE=OS2X | |
193 | SET COMSPEC=sh | |
194 | ||
195 | Notice you can choose whatever you want, if you don't like OS2X. | |
196 | ||
197 | Now, run autoconf in the main directory and in the samples, demos | |
198 | and utils subdirectory. This will generate the OS/2 specific | |
199 | versions of the configure scripts. Now run | |
200 | configure --with-x11 | |
201 | as described above. | |
202 | ||
203 | To verify Lesstif installation, configure will try to compile a | |
204 | sample program that requires X headers/libraries to be either | |
205 | available via C_INCLUDE_PATH and LIBRARY_PATH or you need to | |
206 | explicitly set CFLAGS prior to running configure. | |
207 | ||
208 | If you have pthreads library installed, it will be autodetected | |
209 | and the library will be compiled with thread-support. | |
210 | ||
211 | Note that configure assumes your flex will generate files named | |
212 | "lexyy.c", not "lex.yy.c". If you have a version which does | |
213 | generate "lex.yy.c", you need to manually change the generated | |
214 | makefile. | |
215 | ||
216 | * Building wxX11 on SGI | |
217 | -------------------------- | |
218 | ||
219 | Using the SGI native compilers, it is recommended that you | |
220 | also set CFLAGS and CXXFLAGS before running configure. These | |
221 | should be set to : | |
222 | ||
223 | CFLAGS="-mips3 -n32" | |
224 | CXXFLAGS="-mips3 -n32" | |
225 | ||
226 | This is essential if you want to use the resultant binaries | |
227 | on any other machine than the one it was compiled on. If you | |
228 | have a 64bit machine (Octane) you should also do this to ensure | |
229 | you don't accidently build the libraries as 64bit (which is | |
230 | untested). | |
231 | ||
232 | The SGI native compiler support has only been tested on Irix 6.5. | |
233 | ||
234 | * Create your configuration | |
235 | ----------------------------- | |
236 | ||
237 | Usage: | |
238 | ./configure options | |
239 | ||
240 | If you want to use system's C and C++ compiler, | |
241 | set environment variables CXX and CC as | |
242 | ||
243 | % setenv CC cc | |
244 | % setenv CXX CC | |
245 | % ./configure options | |
246 | ||
247 | to see all the options please use: | |
248 | ||
249 | ./configure --help | |
250 | ||
251 | The basic philosophy is that if you want to use different | |
252 | configurations, like a debug and a release version, | |
253 | or use the same source tree on different systems, | |
254 | you have only to change the environment variable OSTYPE. | |
255 | (Sadly this variable is not set by default on some systems | |
256 | in some shells - on SGI's for example). So you will have to | |
257 | set it there. This variable HAS to be set before starting | |
258 | configure, so that it knows which system it tries to | |
259 | configure for. | |
260 | ||
261 | Configure will complain if the system variable OSTYPE has | |
262 | not been defined. And Make in some circumstances as well... | |
263 | ||
264 | ||
265 | * General options | |
266 | ------------------- | |
267 | ||
268 | Given below are the commands to change the default behaviour, | |
269 | i.e. if it says "--disable-threads" it means that threads | |
270 | are enabled by default. | |
271 | ||
2edb0bde | 272 | Many of the configure options have been thoroughly tested |
1cf13934 JS |
273 | in wxWindows snapshot 6, but not yet all (ODBC not). |
274 | ||
275 | You have to add --with-x11 on platforms, where X11 is | |
2edb0bde | 276 | not the default (on Linux, configure will default to GTK). |
1cf13934 JS |
277 | |
278 | --without-gtk Don't use the GIMP ToolKit (GTK). | |
279 | ||
280 | --with-x11 Use X11. | |
281 | ||
282 | --with-universal Needs to be specified with X11. | |
283 | ||
284 | The following options handle the kind of library you want to build. | |
285 | ||
286 | --disable-threads Compile without thread support. Threads | |
287 | support is also required for the | |
288 | socket code to work. | |
289 | ||
290 | --disable-shared Do not create shared libraries. | |
291 | ||
292 | --disable-optimise Do not optimise the code. Can | |
293 | sometimes be useful for debugging | |
294 | and is required on some architectures | |
295 | such as Sun with gcc 2.8.X which | |
296 | would otherwise produce segvs. | |
297 | ||
298 | --enable-profile Add profiling info to the object | |
299 | files. Currently broken, I think. | |
300 | ||
301 | --enable-no_rtti Enable compilation without creation of | |
302 | C++ RTTI information in object files. | |
303 | This will speed-up compilation and reduce | |
304 | binary size. | |
305 | ||
306 | --enable-no_exceptions Enable compilation without creation of | |
307 | C++ exception information in object files. | |
308 | This will speed-up compilation and reduce | |
309 | binary size. Also fewer crashes during the | |
310 | actual compilation... | |
311 | ||
312 | --enable-no_deps Enable compilation without creation of | |
313 | dependency information. | |
314 | ||
2edb0bde VZ |
315 | --enable-permissive Enable compilation without checking for strict |
316 | ANSI conformance. Useful to prevent the build | |
317 | dying with errors as soon as you compile with | |
318 | Solaris' ANSI-defying headers. | |
1cf13934 JS |
319 | |
320 | --enable-mem_tracing Add built-in memory tracing. | |
321 | ||
322 | --enable-dmalloc Use the dmalloc memory debugger. | |
323 | Read more at www.letters.com/dmalloc/ | |
324 | ||
325 | --enable-debug_info Add debug info to object files and | |
326 | executables for use with debuggers | |
327 | such as gdb (or its many frontends). | |
328 | ||
329 | --enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when | |
330 | compiling. This enable wxWindows' very | |
331 | useful internal debugging tricks (such | |
332 | as automatically reporting illegal calls) | |
333 | to work. Note that program and library | |
334 | must be compiled with the same debug | |
335 | options. | |
336 | ||
337 | * Feature Options | |
338 | ------------------- | |
339 | ||
2edb0bde | 340 | Many of the configure options have been thoroughly tested |
1cf13934 JS |
341 | in wxWindows snapshot 6, but not yet all (ODBC not). |
342 | ||
343 | When producing an executable that is linked statically with wxGTK | |
344 | you'll be surprised at its immense size. This can sometimes be | |
345 | drastically reduced by removing features from wxWindows that | |
346 | are not used in your program. The most relevant such features | |
347 | are | |
348 | ||
349 | --without-libpng Disables PNG image format code. | |
350 | ||
351 | --without-libjpeg Disables JPEG image format code. | |
352 | ||
353 | { --without-odbc Disables ODBC code. Not yet. } | |
354 | ||
355 | --disable-resources Disables the use of *.wxr type | |
356 | resources. | |
357 | ||
358 | --disable-threads Disables threads. Will also | |
359 | disable sockets. | |
360 | ||
361 | --disable-sockets Disables sockets. | |
362 | ||
363 | --disable-dnd Disables Drag'n'Drop. | |
364 | ||
365 | --disable-clipboard Disables Clipboard. | |
366 | ||
2edb0bde | 367 | --disable-serial Disables object instance serialisation. |
1cf13934 JS |
368 | |
369 | --disable-streams Disables the wxStream classes. | |
370 | ||
371 | --disable-file Disables the wxFile class. | |
372 | ||
373 | --disable-textfile Disables the wxTextFile class. | |
374 | ||
375 | --disable-intl Disables the internationalisation. | |
376 | ||
377 | --disable-validators Disables validators. | |
378 | ||
379 | --disable-accel Disables accel. | |
380 | ||
381 | Apart from disabling certain features you can very often "strip" | |
382 | the program of its debugging information resulting in a significant | |
383 | reduction in size. | |
384 | ||
385 | * Compiling | |
386 | ------------- | |
387 | ||
388 | The following must be done in the base directory (e.g. ~/wxGTK | |
389 | or ~/wxWin or whatever) | |
390 | ||
391 | Now the makefiles are created (by configure) and you can compile | |
392 | the library by typing: | |
393 | ||
394 | make | |
395 | ||
396 | make yourself some coffee, as it will take some time. On an old | |
397 | 386SX possibly two weeks. During compilation, you'll get a few | |
398 | warning messages depending in your compiler. | |
399 | ||
400 | If you want to be more selective, you can change into a specific | |
2edb0bde | 401 | directory and type "make" there. |
1cf13934 | 402 | |
2edb0bde | 403 | Then you may install the library and its header files under |
1cf13934 JS |
404 | /usr/local/include/wx and /usr/local/lib respectively. You |
405 | have to log in as root (i.e. run "su" and enter the root | |
406 | password) and type | |
407 | ||
408 | make install | |
409 | ||
410 | You can remove any traces of wxWindows by typing | |
411 | ||
412 | make uninstall | |
413 | ||
414 | If you want to save disk space by removing unnecessary | |
415 | object-files: | |
416 | ||
417 | make clean | |
418 | ||
419 | in the various directories will do the work for you. | |
420 | ||
421 | * Creating a new Project | |
422 | -------------------------- | |
423 | ||
424 | 1) The first way uses the installed libraries and header files | |
425 | automatically using wx-config | |
426 | ||
427 | g++ myfoo.cpp `wx-config --libs` `wx-config --cflags` -o myfoo | |
428 | ||
429 | Using this way, a make file for the minimal sample would look | |
430 | like this | |
431 | ||
432 | CXX = g++ | |
433 | ||
434 | minimal: minimal.o | |
435 | $(CXX) -o minimal minimal.o `wx-config --libs` | |
436 | ||
437 | minimal.o: minimal.cpp mondrian.xpm | |
438 | $(CXX) `wx-config --cflags` -c minimal.cpp -o minimal.o | |
439 | ||
440 | clean: | |
441 | rm -f *.o minimal | |
442 | ||
443 | This is certain to become the standard way unless we decide | |
2edb0bde | 444 | to stick to tmake. |
1cf13934 JS |
445 | |
446 | 2) The other way creates a project within the source code | |
447 | directories of wxWindows. For this endeavour, you'll need | |
448 | GNU autoconf version 2.14 and add an entry to your Makefile.in | |
449 | to the bottom of the configure.in script and run autoconf | |
450 | and configure before you can type make. | |
451 | ||
452 | * Further notes by Julian Smart | |
453 | --------------------------------- | |
454 | ||
455 | - You may find the following script useful for compiling wxX11, | |
456 | especially if installing from zips (which don't preserve file | |
457 | permissions). Make this script executable with the command | |
458 | chmod a+x makewxx11. | |
459 | ||
460 | -------:x-----Cut here-----:x----- | |
461 | # makewxx11 | |
462 | # Sets permissions (in case we extracted wxX11 from zip files) | |
463 | # and makes wxX11. | |
464 | # Call from top-level wxWindows directory. | |
465 | # Note that this uses standard (but commonly-used) configure options; | |
466 | # if you're feeling brave, you may wish to compile with threads: | |
467 | # if they're not supported by the target platform, they will be disabled | |
468 | # anyhow | |
469 | # -- Julian Smart | |
470 | chmod a+x configure config.sub config.guess | |
471 | ./configure --with-shared --with-x11 --with-universal --without-gtk --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc | |
472 | make | |
473 | -------:x-----Cut here-----:x----- | |
474 | ||
475 | This script will build wxX11 using shared libraries. If you want to build | |
476 | a static wxWindows library, use --disable-shared. | |
477 | ||
478 | Troubleshooting | |
479 | --------------- | |
480 | ||
481 | - Solaris compilation with gcc: if the compiler has problems with the variable argument | |
482 | functions, try putting the gcc fixinclude file paths early in the include | |
483 | path. | |
484 | ||
485 | - If you operator-related compile errors or strange memory problems | |
486 | (for example in deletion of string arrays), set wxUSE_GLOBAL_MEMORY_OPERATORS | |
487 | and wxUSE_MEMORY_TRACING to 0 in setup.h, and recompile. | |
488 | ||
489 | - If you get an internal compiler error in gcc, turn off optimisations. | |
490 | ||
491 | - Some compilers, such as Sun C++, may give a lot of warnings about | |
492 | virtual functions being hidden. Please ignore these, it's correct C++ syntax. | |
493 | If you find any incorrect instances, though, such as a | |
494 | missing 'const' in an overridden function, please let us know. | |
495 | ||
496 | Other Notes | |
497 | ----------- | |
498 | ||
499 | - Debugging mode is switched on by default in the makefiles, but using | |
500 | configure will create a release build of the library by default: it's | |
501 | recommended to use --with-debug_info and --with-debug_flag configure | |
502 | switches while developing your application. To compile in non-debug | |
503 | mode, remove the -D__WXDEBUG__ switch in make.env (or if using the | |
504 | configure system, change --with-debug_flag to --without_debug_flag | |
505 | and --with-debug_info to --without-debug_info in the makewxx11 | |
506 | script). | |
507 | ||
508 | Bug reports | |
509 | ----------- | |
510 | ||
511 | Please send bug reports with a description of your environment, | |
512 | compiler and the error message(s) to the wxwin-developers mailing list at: | |
513 | ||
514 | wx-dev@lists.wxwindows.org | |
515 | ||
516 | Julian Smart, Robert Roebling and Vadim Zeitlin, February 2002. | |
517 |