diff --git a/docs/gtk/install.txt b/docs/gtk/install.txt index d334861711..5d9ebb9ed6 100644 --- a/docs/gtk/install.txt +++ b/docs/gtk/install.txt @@ -1,12 +1,12 @@ - !!! When sending bug reports tell us what version of wxWindows you are - using (including the beta) and what compiler on what system. One + !!! When sending bug reports tell us what version of wxWindows you are + using (including the beta) and what compiler on what system. One example: wxGTK 2.3.0, egcs 1.1.1, Redhat 6.2 !!! * The most simple case ----------------------- -If you compile wxWindows on Linux for the first time and don't like to read +If you compile wxWindows on Linux for the first time and don't like to read install instructions just do (in the base dir): > ./configure --with-gtk @@ -34,14 +34,14 @@ If you want to remove wxWindows on Unix you can do this: * The expert case ----------------- -If you want to do some more serious cross-platform programming with wxWindows, -such as for GTK and Motif, you can now build two complete libraries and use -them concurretly. For this end, you have to create a directory for each build +If you want to do some more serious cross-platform programming with wxWindows, +such as for GTK and Motif, you can now build two complete libraries and use +them concurretly. For this end, you have to create a directory for each build of wxWindows - you may also want to create different versions of wxWindows -and test them concurrently. Most typically, this would be a version configured -with --enable-debug_flag and one without. Note, that only one build can currently +and test them concurrently. Most typically, this would be a version configured +with --enable-debug_flag and one without. Note, that only one build can currently be installed, so you'd have to use local version of the library for that purpose. -For building three versions (one GTK, one Motif and a debug version of the GTK +For building three versions (one GTK, one Motif and a debug version of the GTK source) you'd do this: md buildmotif @@ -65,25 +65,36 @@ cd .. * The most simple errors ------------------------ -configure reports, that you don't have GTK 1.2 installed although you are -very sure you have. Well, you have installed it, but you also have another -version of the GTK installed, which you may need to remove including other -versions of glib (and its headers). Also, look for the PATH variable and check -if it includes the path to the correct gtk-config! The check your LDPATH if it -points to the correct library. There is no way to compile wxGTK if configure -doesn't pass this test as all this test does is compile and link a GTK program. +For any configure errors: please look at config.log file which was generated +during configure run, it usually contains some useful information. -You get errors during compilation: The reason is that you probably have a broken -compiler, which includes almost everything that is called gcc. If you use gcc 2.8 -you have to disable optimsation as the compiler will give up with an internal -compiler error. +configure reports, that you don't have GTK 1.2 installed although you are +very sure you have. Well, you have installed it, but you also have another +version of the GTK installed, which you may need to remove including other +versions of glib (and its headers). Or maybe you installed it in non default +location and configure can't find it there, so please check that your PATH +variable includes the path to the correct gtk-config. Also check that your +LD_LIBRARY_PATH or equivalent variable contains the path to GTK+ libraries if +they were installed in a non default location. -If there is just any way for you to use egcs, use egcs. We cannot fix gcc. +You get errors from make: please use GNU make instead of the native make +program. Currently wxWindows can be built only with GNU make, BSD make and +Solaris make. Other versions might work or not (any which don't have VPATH +support definitely won't). -You get immediate segfault when starting any sample or application: This is either -due to having compiled the library with different flags or options than your program - -typically you might have the __WXDEBUG__ option set for the library but not for your -program - or due to using a broken compiler (and its optimisation) such as GCC 2.8. +You get errors during compilation: The reason is that you probably have a +broken compiler, which includes a lot of old gcc versions. In particular, if +you use gcc 2.8 you have to disable optimsation as the compiler will give up +with an internal compiler error. + +You get immediate segfault when starting any sample or application: This is +either due to having compiled the library with different flags or options than +your program - typically you might have the __WXDEBUG__ option set for the +library but not for your program - or due to using a broken compiler (and its +optimisation) such as gcc 2.8. + +Linker complains about missing PROIO_yy_flex_alloc and similar symbols: you +probably have an old version of flex, 2.5.4 is recommended. * The most simple program ------------------------- @@ -95,37 +106,38 @@ gcc myfoo.cpp `wx-config --libs --cflags` -o myfoo * General ----------------------- -The Unix variants of wxWindows use GNU configure. If you have problems with your +The Unix variants of wxWindows use GNU configure. If you have problems with your make use GNU make instead. -If you have general problems with installation, read my homepage at +If you have general problems with installation, read my homepage at http://wesley.informatik.uni-freiburg.de/~wxxt - -for newest information. If you still don't have any success, please send a bug -report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF -YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF GTK, WXGTK, WHAT DISTRIBUTION + +for newest information. If you still don't have any success, please send a bug +report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF +YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF GTK, WXGTK, WHAT DISTRIBUTION YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried... * GUI libraries ----------------------- -wxWindows/GTK requires the GTK+ library to be installed on your system. It has to -be a stable version, preferebly version 1.2.3. +wxWindows/GTK requires the GTK+ library to be installed on your system. It has +to be a stable version, preferebly version 1.2.10 (at least 1.2.3 is required, +1.2.7 is strongly recommended). You can get the newest version of the GTK+ from the GTK homepage at: http://www.gtk.org - -We also mirror GTK+ 1.2.3 at my ftp site. You'll find information about downloading + +We also mirror GTK+ at my ftp site. You'll find information about downloading at my homepage. - + * Additional libraries ----------------------- -wxWindows/Gtk requires a thread library and X libraries known to work with threads. -This is the case on all commercial Unix-Variants and all Linux-Versions that are -based on glibc 2 except RedHat 5.0 which is broken in many aspects. As of writing +wxWindows/Gtk requires a thread library and X libraries known to work with threads. +This is the case on all commercial Unix-Variants and all Linux-Versions that are +based on glibc 2 except RedHat 5.0 which is broken in many aspects. As of writing this, these Linux distributions have correct glibc 2 support: - RedHat 5.1 @@ -133,17 +145,17 @@ this, these Linux distributions have correct glibc 2 support: - Stampede - DLD 6.0 - SuSE 6.0 - -You can disable thread support by running -./configure "--disable-threads" +You can disable thread support by running + +./configure --disable-threads make su make install ldconfig exit - -NB: DO NOT COMPILE WXGTK WITH GCC 2.7 AND THREADS, SINCE ALL PROGRAMS WILL CRASH UPON + +NB: DO NOT COMPILE WXGTK WITH GCC 2.7 AND THREADS, SINCE ALL PROGRAMS WILL CRASH UPON START-UP! Just always use egcs and be happy. * Building wxGTK on OS/2 @@ -153,10 +165,10 @@ Please send comments and question about the OS/2 installation to Andrea Venturoli and patches to the wxWindows mailing list. -You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3 or newer), -GTK+ (1.2.5 or newer), emx (0.9d fix 1), flex (2.5.4), yacc (1.8), -korn shell (5.2.13), Autoconf (2.13), GNU file utilities (3.6), -GNU text utilities (1.3), GNU shell utilites (1.12), m4 (1.4), +You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3 or newer), +GTK+ (1.2.5 or newer), emx (0.9d fix 1), flex (2.5.4), yacc (1.8), +korn shell (5.2.13), Autoconf (2.13), GNU file utilities (3.6), +GNU text utilities (1.3), GNU shell utilites (1.12), m4 (1.4), sed (2.05), grep (2.0), Awk (3.0.3), GNU Make (3.76.1). Open an OS/2 prompt and switch to the directory above. @@ -164,7 +176,7 @@ First set some global environment variables we need: SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__ SET CFLAGS=-Zmtd -D__ST_MT_ERRNO__ -SET OSTYPE=OS2X +SET OSTYPE=OS2X SET COMSPEC=sh Notice you can choose whatever you want, if you don't like OS2X. @@ -188,16 +200,16 @@ makefile. -------------------------- Using the SGI native compilers, it is recommended that you -also set CFLAGS and CXXFLAGS before running configure. These +also set CFLAGS and CXXFLAGS before running configure. These should be set to : -CFLAGS="-mips3 -n32" +CFLAGS="-mips3 -n32" CXXFLAGS="-mips3 -n32" -This is essential if you want to use the resultant binaries -on any other machine than the one it was compiled on. If you -have a 64bit machine (Octane) you should also do this to ensure -you don't accidently build the libraries as 64bit (which is +This is essential if you want to use the resultant binaries +on any other machine than the one it was compiled on. If you +have a 64bit machine (Octane) you should also do this to ensure +you don't accidently build the libraries as 64bit (which is untested). The SGI native compiler support has only been tested on Irix 6.5. @@ -206,31 +218,23 @@ The SGI native compiler support has only been tested on Irix 6.5. ----------------------------- Usage: - ./configure options + ./configure options If you want to use system's C and C++ compiler, set environment variables CC and CCC as - % setenv CC cc - % setenv CCC CC - % ./configure options + % setenv CC cc + % setenv CCC CC + % ./configure options to see all the options please use: - ./configure --help + ./configure --help -The basic philosophy is that if you want to use different -configurations, like a debug and a release version, -or use the same source tree on different systems, -you have only to change the environment variable OSTYPE. -(Sadly this variable is not set by default on some systems -in some shells - on SGI's for example). So you will have to -set it there. This variable HAS to be set before starting -configure, so that it knows which system it tries to -configure for. - -Configure will complain if the system variable OSTYPE has -not been defined. And Make in some circumstances as well... +It is recommended to build wxWindows in another directory (maybe a +subdirectory of your wxWindows installation) as this allows you to +have multiple configurations (for example, debug and release or GTK +and Motif) simultaneously. * General options @@ -242,63 +246,63 @@ are enabled by default. Normally, you won't have to choose a toolkit, because when you download wxGTK, it will default to --with-gtk etc. But -if you use all of our CVS repository you have to choose a +if you use all of our CVS repository you have to choose a toolkit. You must do this by running configure with either of: --with-gtk Use the GIMP ToolKit (GTK). Default. - - --with-motif Use either Motif or Lesstif - Configure will look for both. + + --with-motif Use either Motif or Lesstif + Configure will look for both. The following options handle the kind of library you want to build. - --disable-threads Compile without thread support. + --disable-threads Compile without thread support. - --disable-shared Do not create shared libraries, but + --disable-shared Do not create shared libraries, but build static libraries instead. - --disable-optimise Do not optimise the code. Can - sometimes be useful for debugging + --disable-optimise Do not optimise the code. Can + sometimes be useful for debugging and is required on some architectures such as Sun with gcc 2.8.X which would otherwise produce segvs. - --enable-profile Add profiling info to the object - files. Currently broken, I think. - - --enable-no_rtti Enable compilation without creation of - C++ RTTI information in object files. - This will speed-up compilation and reduce + --enable-profile Add profiling info to the object + files. Currently broken, I think. + + --enable-no_rtti Enable compilation without creation of + C++ RTTI information in object files. + This will speed-up compilation and reduce binary size. - - --enable-no_exceptions Enable compilation without creation of - C++ exception information in object files. - This will speed-up compilation and reduce + + --enable-no_exceptions Enable compilation without creation of + C++ exception information in object files. + This will speed-up compilation and reduce binary size. Also fewer crashes during the actual compilation... - - --enable-no_deps Enable compilation without creation of - dependency information. - - --enable-permissive Enable compilation without creation of - giving erros as soon as you compile with - Solaris' ANSI-defying headers. - - --enable-mem_tracing Add built-in memory tracing. - - --enable-dmalloc Use the dmalloc memory debugger. - Read more at www.letters.com/dmalloc/ - - --enable-debug_info Add debug info to object files and - executables for use with debuggers - such as gdb (or its many frontends). - --enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when - compiling. This enable wxWindows' very + --enable-no_deps Enable compilation without creation of + dependency information. + + --enable-permissive Enable compilation without creation of + giving erros as soon as you compile with + Solaris' ANSI-defying headers. + + --enable-mem_tracing Add built-in memory tracing. + + --enable-dmalloc Use the dmalloc memory debugger. + Read more at www.letters.com/dmalloc/ + + --enable-debug_info Add debug info to object files and + executables for use with debuggers + such as gdb (or its many frontends). + + --enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when + compiling. This enable wxWindows' very useful internal debugging tricks (such as automatically reporting illegal calls) to work. Note that program and library - must be compiled with the same debug + must be compiled with the same debug options. * Feature Options @@ -306,54 +310,53 @@ The following options handle the kind of library you want to build. When producing an executable that is linked statically with wxGTK you'll be surprised at its immense size. This can sometimes be -drastically reduced by removing features from wxWindows that +drastically reduced by removing features from wxWindows that are not used in your program. The most relevant such features are - --with-odbc Enables ODBC code. This is disabled + --with-odbc Enables ODBC code. This is disabled by default because iODBC is under the - L-GPL license. - - --without-libpng Disables PNG image format code. - - --without-libjpeg Disables JPEG image format code. - - --without-libtiff Disables TIFF image format code. - - --disable-pnm Disables PNM image format code. - - --disable-gif Disables GIF image format code. - - --disable-pcx Disables PCX image format code. - - --disable-iff Disables IFF image format code. - - --disable-resources Disables the use of *.wxr type - resources. - - --disable-threads Disables threads. Will also - disable sockets. + L-GPL license which is less liberal than + wxWindows license. - --disable-sockets Disables sockets. + --without-libpng Disables PNG image format code. + + --without-libjpeg Disables JPEG image format code. + + --without-libtiff Disables TIFF image format code. + + --disable-pnm Disables PNM image format code. + + --disable-gif Disables GIF image format code. + + --disable-pcx Disables PCX image format code. + + --disable-iff Disables IFF image format code. + + --disable-resources Disables the use of *.wxr type resources. + + --disable-threads Disables threads. Will also disable sockets. + + --disable-sockets Disables sockets. + + --disable-dnd Disables Drag'n'Drop. + + --disable-clipboard Disables Clipboard. + + --disable-serial Disables object instance serialiasation. + + --disable-streams Disables the wxStream classes. + + --disable-file Disables the wxFile class. + + --disable-textfile Disables the wxTextFile class. + + --disable-intl Disables the internationalisation. + + --disable-validators Disables validators. + + --disable-accel Disables accelerators support. - --disable-dnd Disables Drag'n'Drop. - - --disable-clipboard Disables Clipboard. - - --disable-serial Disables object instance serialiasation. - - --disable-streams Disables the wxStream classes. - - --disable-file Disables the wxFile class. - - --disable-textfile Disables the wxTextFile class. - - --disable-intl Disables the internationalisation. - - --disable-validators Disables validators. - - --disable-accel Disables accel. - Apart from disabling certain features you can very often "strip" the program of its debugging information resulting in a significant reduction in size. @@ -364,13 +367,13 @@ reduction in size. The following must be done in the base directory (e.g. ~/wxGTK or ~/wxWin or whatever) -Now the makefiles are created (by configure) and you can compile +Now the makefiles are created (by configure) and you can compile the library by typing: - make + make make yourself some coffee, as it will take some time. On an old -386SX possibly two weeks. During compilation, you'll get a few +386SX possibly two weeks. During compilation, you'll get a few warning messages depending in your compiler. If you want to be more selective, you can change into a specific @@ -381,16 +384,16 @@ Then you may install the library and it's header files under have to log in as root (i.e. run "su" and enter the root password) and type - make install + make install You can remove any traces of wxWindows by typing make uninstall - + If you want to save disk space by removing unnecessary object-files: - make clean +make clean in the various directories will do the work for you. @@ -408,18 +411,18 @@ like this CC = gcc minimal: minimal.o - $(CC) -o minimal minimal.o `wx-config --libs` + $(CC) -o minimal minimal.o `wx-config --libs` minimal.o: minimal.cpp mondrian.xpm - $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o + $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o -clean: +clean: rm -f *.o minimal This is certain to become the standard way unless we decide to sitch to tmake. -2) The other way creates a project within the source code +2) The other way creates a project within the source code directories of wxWindows. For this endeavour, you'll need GNU autoconf version 2.14 and add an entry to your Makefile.in to the bottom of the configure.in script and run autoconf