2 !!! When sending bug reports tell us what version of wxWindows you are
3 using (including the beta) and what compiler on what system. One
4 example: wxGTK 2.1 beta 6, egcs 1.1.1, Redhat 5.0 !!!
7 -----------------------
9 If you compile wxWindows on Unix for the first time and don't like to read
10 install instructions just do (in the base dir):
14 su <type root password>
19 If you want to remove wxWindows on Unix you can do this:
21 su <type root password>
29 If you want to do some more serious cross-platform programming with wxWindows,
30 such as for GTK and Motif, you can now build two complete libraries and use
31 them concurretly. For this end, you have to create a directory for each build
32 of wxWindows - you may also want to create different versions of wxWindows
33 and test them concurrently. Most typically, this would be a version configured
34 with --enable-debug_flag and one without. Note, that only one build can currently
35 be installed, so you'd have to use local version of the library for that purpose.
36 For building three versions (one GTK, one Motif and a debug version of the GTK
37 source) you'd do this:
41 ../configure --with-motif
47 ../configure --with-gtk
53 ../configure --with-gtk --enable-debug_flag
57 * The most simple errors
58 ------------------------
60 configure reports, that you don't have GTK 1.X installed although you are
61 very sure you have. Well, you have installed it, but you also have another
62 version of the GTK installed, which you may need to remove including other
63 versions of glib (and its headers). Also, look for the PATH variable and check
64 if it includes the path to the correct gtk-config! The check your LDPATH if it
65 points to the correct library. There is no way to compile wxGTK if configure
66 doesn't pass this test as all this test does is compile and link a GTK program.
68 You get errors during compilation: The reason is that you probably have a broken
69 compiler, which includes almost everything that is called gcc. If you use gcc 2.8
70 you have to disable optimsation as the compiler will give up with an internal
73 If there is just any way for you to use egcs, use egcs. We cannot fix gcc.
75 You get immediate segfault when starting any sample or application: This is either
76 due to having compiled the library with different flags or options than your program -
77 typically you might have the __WXDEBUG__ option set for the library but not for your
78 program - or due to using a broken compiler (and its optimisation) such as GCC 2.8.
80 * The most simple program
81 -------------------------
83 Now create your super-application myfoo.app and compile anywhere with
85 g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo
88 -----------------------
90 The Unix variants of wxWindows use GNU configure. If you have problems with your
91 make use GNU make instead.
93 If you have general problems with installation, read my homepage at
95 http://wesley.informatik.uni-freiburg.de/~wxxt
97 for newest information. If you still don't have any success, please send a bug
98 report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF
99 YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF GTK, WXGTK, WHAT DISTRIBUTION
100 YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
103 -----------------------
105 wxWindows/GTK requires the GTK+ library to be installed on your system. It has to
106 be a stable version, preferebly version 1.2.3. You can use GTK 1.0 in connection
107 with wxWindows, albeit without Drag'n'Drop. wxWindows does work with the 1.1.X
108 versions of the GTK+ library.
110 You can get the newest version of the GTK+ from the GTK homepage at:
114 We also mirror GTK+ 1.0.6 at my ftp site. You'll find information about downloading
117 * Additional libraries
118 -----------------------
120 wxWindows/Gtk requires a thread library and X libraries known to work with threads.
121 This is the case on all commercial Unix-Variants and all Linux-Versions that are
122 based on glibc 2 except RedHat 5.0 which is broken in many aspects. As of writing
123 this, these Linux distributions have correct glibc 2 support:
131 You can disable thread support by running
133 ./configure "--disable-threads"
135 su <type root password>
140 NB: DO NOT COMPILE WXGTK WITH GCC AND THREADS, SINCE ALL PROGRAMS WILL CRASH UPON
141 START-UP! Just always use egcs and be happy.
143 * Building wxGTK on OS/2
144 --------------------------
146 Please send comments and question about the OS/2 installation
147 to Andrea Venturoli <a.ventu@flashnet.it> and patches to
148 make the installation work (better) to me (Robert Roebling).
150 You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3),
151 gtk+ (?), emx (0.9d fix 1), flex (2.5.4), yacc (1.8),
152 korn shell (5.2.13), Autoconf (?), GNU file utilities (3.6),
153 GNU text utilities (1.3), GNU shell utilites (1.12), m4 (1.4),
154 sed (2.05), grep (2.0), Awk (3.0.3), GNU Make (3.76.1).
156 Open an OS/2 prompt and switch to the directory above.
157 First set some global environment variables we need:
159 SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__
163 Notice you can choose whatever you want, if you don't like OS2X.
165 * Building wxGTK on SGI
166 --------------------------
168 Using the SGI native compilers, it is recommended that you
169 also set CFLAGS and CXXFLAGS before running configure. These
173 CXXFLAGS="-mips3 -n32"
175 This is essential if you want to use the resultant binaries
176 on any other machine than the one it was compiled on. If you
177 have a 64bit machine (Octane) you should also do this to ensure
178 you don't accidently build the libraries as 64bit (which is
181 The SGI native compiler support has only been tested on Irix 6.5.
183 * Create your configuration
184 -----------------------------
189 If you want to use system's C and C++ compiler,
190 set environment variables CC and CCC as
194 % ./configure options
196 to see all the options please use:
200 The basic philosophy is that if you want to use different
201 configurations, like a debug and a release version,
202 or use the same source tree on different systems,
203 you have only to change the environment variable OSTYPE.
204 (Sadly this variable is not set by default on some systems
205 in some shells - on SGI's for example). So you will have to
206 set it there. This variable HAS to be set before starting
207 configure, so that it knows which system it tries to
210 Configure will complain if the system variable OSTYPE has
211 not been defined. And Make in some circumstances as well...
217 Given below are the commands to change the default behaviour,
218 i.e. if it says "--disable-threads" it means that threads
219 are enabled by default.
221 Many of the confiugre options have been thoroughly tested
222 in wxWindows snapshot 6, but not yet all (ODBC not).
224 Normally, you won't have to choose a toolkit, because when
225 you download wxGTK, it will default to --with-gtk etc. But
226 if you use all of our CVS repository you have to choose a
227 toolkit. You must do this by running configure with either of:
229 --without-gtk Don't use the GIMP ToolKit (GTK)
231 --with-motif Use either Motif or Lesstif
232 Configure will look for both.
234 The following options handle the kind of library you want to build.
236 --disable-threads Compile without thread support. Threads
237 support is also required for the
240 --disable-shared Do not create shared libraries.
242 --disable-optimise Do not optimise the code. Can
243 sometimes be useful for debugging
244 and is required on some architectures
245 such as Sun with gcc 2.8.X which
246 would otherwise produce segvs.
248 --enable-profile Add profiling info to the object
249 files. Currently broken, I think.
251 --enable-mem_tracing Add built-in memory tracing.
253 --enable-dmalloc Use the dmalloc memory debugger.
254 Read more at www.letters.com/dmalloc/
256 --enable-debug_info Add debug info to object files and
257 executables for use with debuggers
258 such as gdb (or its many frontends).
260 --enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when
261 compiling. This enable wxWindows' very
262 useful internal debugging tricks (such
263 as automatically reporting illegal calls)
264 to work. Note that program and library
265 must be compiled with the same debug
271 Many of the confiugre options have been thoroughly tested
272 in wxWindows snapshot 6, but not yet all (ODBC not).
274 When producing an executable that is linked statically with wxGTK
275 you'll be surprised at its immense size. This can sometimes be
276 drastically reduced by removing features from wxWindows that
277 are not used in your program. The most relevant such features
280 --without-libpng Disables PNG image format code.
282 --without-libjpeg Disables JPEG image format code.
284 { --without-odbc Disables ODBC code. Not yet. }
286 --disable-resources Disables the use of *.wxr type
289 --disable-threads Disables threads. Will also
292 --disable-sockets Disables sockets.
294 --disable-dnd Disables Drag'n'Drop.
296 --disable-clipboard Disables Clipboard.
298 --disable-serial Disables object instance serialiasation.
300 --disable-streams Disables the wxStream classes.
302 --disable-file Disables the wxFile class.
304 --disable-textfile Disables the wxTextFile class.
306 --disable-intl Disables the internationalisation.
308 --disable-validators Disables validators.
310 --disable-accel Disables accel.
312 Apart from disabling certain features you can very often "strip"
313 the program of its debugging information resulting in a significant
319 The following must be done in the base directory (e.g. ~/wxGTK
320 or ~/wxWin or whatever)
322 Now the makefiles are created (by configure) and you can compile
323 the library by typing:
327 make yourself some coffee, as it will take some time. On an old
328 386SX possibly two weeks. During compilation, you'll get a few
329 warning messages depending in your compiler.
331 If you want to be more selective, you can change into a specific
332 directiry and type "make" there.
334 Then you may install the library and it's header files under
335 /usr/local/include/wx and /usr/local/lib respectively. You
336 have to log in as root (i.e. run "su" and enter the root
341 You can remove any traces of wxWindows by typing
345 If you want to save disk space by removing unnecessary
350 in the various directories will do the work for you.
352 * Creating a new Project
353 --------------------------
355 1) The first way uses the installed libraries and header files
356 automatically using wx-config
358 g++ myfoo.cpp `wx-config --libs` `wx-config --cflags` -o myfoo
360 Using this way, a make file for the minimal sample would look
366 $(CC) -o minimal minimal.o `wx-config --libs`
368 minimal.o: minimal.cpp mondrian.xpm
369 $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o
374 This is certain to become the standard way unless we decide
377 2) The other way creates a project within the source code
378 directories of wxWindows. For this endeavour, you'll need
379 the usual number of GNU tools, at least
381 GNU automake version 1.4
382 GNU autoheader version 2.14
383 GNU autoconf version 2.14
384 GNU libtool version 1.3
391 and if you have all this then you probably know enough to
392 go ahead yourself :-)
394 ----------------------
396 In the hope that it will be useful,
398 Robert Roebling <roebling@sun2.ruf.uni-freiburg.de>