X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c98f04213ed354d0116092e87a30db5dc69c5709..0180dad680ecbe4cb5cf8e6e45ce569f7a1029f7:/docs/gtk/install.txt diff --git a/docs/gtk/install.txt b/docs/gtk/install.txt index 24286b8abf..706b753d49 100644 --- a/docs/gtk/install.txt +++ b/docs/gtk/install.txt @@ -1,96 +1,162 @@ + + !!! 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.1 beta 6, egcs 1.1.1, Redhat 5.0 !!! + * The most simple case ----------------------- -If you compile wxWindows on Unix for the first time and don't like -to read install instructions just do (in the base dir): +If you compile wxWindows on Unix for the first time and don't +like to read install instructions just do (in the base dir): -./configure --with-gtk --with-shared --without-threads +./configure +make +su +make install +ldconfig +exit + +If you want to remove wxWindows on Unix you can do this: + +su +make uninstall +ldconfig +exit + +* 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 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 currenty be installed, so you'd +have to use local version of the library for that purpose. +For building three version, one GTK, one Motif and a debug +version of the GTK source, you'd do this: + +md buildmotif +cd buildmotif +../configure --with-motif make +cd .. -and drink 10 coffees. +md buildgtk +cd buildgtk +../configure --with-gtk +make +cd .. +md buildgtkd +cd buildgtkd +../configure --with-gtk --enable-debug +make +cd .. + +* The most simple errors +------------------------ + +configure reports, that you don't have GTK 1.X installed +although you are certainly sure you have. Well, you have +installed it, but you also have another version of the +GTK installed, which you may need to removed 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. + +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. + +If there is just any way for you to use egcs, use egcs. +We are sorry, but we cannot fix gcc. + +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. + +* The most simple program +------------------------- + +Now create your super-application myfoo.app and compile anywhere +with + +g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo * General ----------------------- -The Unix variants of wxWindows use GNU configure. If you have problems -with your make use GNU make instead. +The Unix variants of wxWindows use GNU configure. If you have +problems with your make use GNU make instead. -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. +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 requires a GUI toolkit to be installed. Does that make -sense? So far only the GTK is supported, but we hope to provide -the choice between GTK, Qt, Motif/Lesstif in the not so distant -future. +wxWindows/GTK requires the GTK+ library to be installed on your system. +It has to be a stable version, preferebly version 1.2.3. You can use +GTK 1.0 in connection with wxWindows, but only without Drag'n'Drop. +wxWindows does work with the 1.1.X versions of the GTK+ library. -You can get the newest version of the GTK from the GTK homepage +You can get the newest version of the GTK+ from the GTK homepage at http://www.gtk.org -The newest versin of Qt can be downloaded for free from the Trolltec's -site at - http://www.troll.no - -Lesstif can be downloaded from their site -at - http://www.lesstif.org - -If you want to develop using Motif, you need to buy it, unless it comes -with your operating system such as all commercial Unices, as well as -RedHat's, SuSe's and probably other's Linux Motif editions. - +We also mirror GTK+ 1.2.1 at my ftp site soon. You'll find information +about downloading at my homepage. + * Additional libraries ----------------------- -There will be a few more features of wxWindows, which will -require further libraries (on some platforms). These -features will be optional. I hope to teach configure -to check that out automatically. - -Thread support: - - Requires pthreads under Linux with glibc 2. pthreads are - always present on such systems, so just compile, unless - you have RedHat 5.0, which has a broken combination of - glibc 2 and X. In this case, you have to run configure - with "--without-threads". - - Requires PCthreads under Linux with libc 5. If you - haven't installed pcthreads, there will be no thread - support in wxWindows, but the library will compile. - - Requires Posix threads on commercial Unix system, - which are always present. Just compile. - - On SGI Irix we first look for sprocs, then pthreads and - use the last one found. - -Python scripting language support: - - Requires Python. Soon to come. +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 + - Debian 2.0 + - Stampede + - DLD 6.0 + - SuSE 6.0 + +You can disable thread support by running + +./configure "--disable-threads" +make +su +make install +ldconfig +exit -* Other things to do ------------------------------ - -wxGTK and wxMotif/wxLesstif require the built-in -ImLib/GdkImlib to be configured. For that purpose -copy the two files from /misc/imlib to your -home directory and rename "imrc" -> ".imrc". -You may also edit imrc by hand as you like. -The palette file is required when using -wxWindows in 256-colour mode. - -If you want to use wxWindows's ODBC support, you'll have -to create a .odbc.ini file. The readme file in -~/src/iodbc tells you what to do. - +NB: DO NOT COMPILE WXGTK WITH GCC AND THREADS, SINCE +ALL PROGRAMS WILL CRASH UPON START-UP! Just always +use egcs and be happy. * Create your configuration ----------------------------- @@ -141,122 +207,169 @@ not been defined. And Make in some circumstances as well... * General options ------------------- -Obviously, you have to choose a toolkit. You must do this by -running configure with either of +The confiugre options have not yet been thoroughly tested +in wxWindows snapshot 6. + +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 +toolkit. You must do this by running configure with either of: --with-gtk Use the GIMP ToolKit (GTK) - --with-qt Use Qt from TrollTec - --with-motif Use either Motif or Lesstif Configure will look for both. The following options handle the kind of library you want to build. - --without-threads Compile without thread support. + --disable-threads Compile without thread support. Threads + support is also required for the + socket code to work. - --with-shared Create shared libraries. + --disable-shared Do not create shared libraries. - --without-optimise Do not optimise the code. + --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. - --with-profile Add profiling info to the object + --enable-profile Add profiling info to the object files. Currently broken, I think. - --with-mem_tracing Add built-in memory tracing. - This doesn't work well with gcc. + --enable-mem_tracing Add built-in memory tracing. - --with-dmalloc Use the dmalloc memory debugger. + --enable-dmalloc Use the dmalloc memory debugger. Read more at www.letters.com/dmalloc/ - --with-debug_info Add debug info to object files and - executables. - - --with-debug_flag Define __DEBUG__ and __WXDEBUG__ when - compiling. + --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 + options. * Feature Options ------------------- -When using the Windows version of wxWindows, it is possible -to edit the file /include/wx/msw/setup.h in order to enable -or disable some features of wxWindows so that the resulting -binaries get smaller. +The confiugre options have not yet been thoroughly tested +in wxWindows snapshot 6. + +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 +are not used in your program. The most relevant such features +are + + --without-libpng Disables PNG image format code. + + --without-libjpeg Disables JPEG image format code. + + --without-odbc Disables ODBC code. + + --disable-wxresources Disables the use of *.wxr type + resources. + + --disable-threads Disables threads. Will also + disable sockets. + + --disable-sockets Disables sockets. -As I don't yet care for binary size and target mainly at -producing a shared library, wxWindows's configure system auto- -matically enables all features, as long as they are already -implemented. + --disable-dnd Disables Drag'n'Drop. + + --disable-clipboard Disables Clipboard. + + --disable-serial Disables object instance serialiasation. + + --disable-streams Disables the wxStream classes. + +Apart from disabling certain features you can very often "strip" +the program of its debugging information resulting in a significant +reduction in size. * Compiling ------------- The following must be done in the base directory (e.g. ~/wxGTK -or ~/wxWin) +or ~/wxWin or whatever) + +Now the makefiles are created (by configure) and you can compile +the library by typing: -First you have to create all makefiles in all subdirectories: + make - make Makefiles +make yourself some coffee, as it will take some time. On an old +386SX possibly two weeks. During compilation, you'll get a few +warning messages depending in your compiler. -Dependencies are generated automatically using +if you want to be more selective, you can change into a specific +directiry and type "make" there. - make depend - -(For some reason, this doesn't seem to work completely.) +Then you may install the library and it's header files under +/usr/local/include/wx and /usr/local/lib respectively. You +have to log in as root (i.e. run "su" and enter the root +password) and type -Now the makefiles are created you can compile everything is as simple -as typing: + make install - make +You can remove any traces of wxWindows by typing + + make uninstall + +If you want to save disk space by removing unnecessary +object-files: -make yourself some coffee, as it will try to compile -ALL the files in this distribution. + make clean -if you want to be more selective: +in the various directories will do the work for you. - make src will build only the base libraries - make utils will build the utils - make samples will build the samples - make other will build the other samples - make user will build the files in the directory other +* Creating a new Project +-------------------------- -Depending on the configuration of some files, the libraries -and binaries will be placed in different directories. -The "global" binaries and libraries will be placed in: +There are two ways to create your own project: - bin/$(OSTYPE) and - lib/$(OSTYPE) respectively +1) The first way uses the installed libraries and header files +automatically using wx-config -"local" binaries and libraries will be placed in: +g++ myfoo.cpp `wx-config --libs` `wx-config --cflags` -o myfoo - (basedir of that application)/$(OSTYPE). +Using this way, a make file for the minimal sample would look +like this -This is also the place where all the object-files will go. +CC = g++ -If you want to conserve disk space by removing unnecessary -object-files: +minimal: minimal.o + $(CC) -o minimal minimal.o `wx-config --libs` - make clean_obj +minimal.o: minimal.cpp mondrian.xpm + $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o -will do the work for you. +clean: + rm -f *.o minimal -* Creating a new Project --------------------------- +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 +directories of wxWindows. For this endeavour, you'll need +the usual number of GNU tools, at least -I propose to put all contributed programs in the directory -"~/wxWin/user", with a directory of its own. +GNU automake version 1.4 +GNU autoheader version 2.14 +GNU autoconf version 2.14 -This directory then should include the following files: +and quite possibly -Makefile (You can copy this one from any application in samples - probably you will not need to edit this one. There is - only one case where you might be interested in changing - this file, but about that see later.) -Makefile.in (This is the base application-Makefile template, from - which the actual Makefile for each system is created. - More about this later) +GNU make +GNU cc -put ALL your source code along with all the other stuff you need for -your application in this directory (subdirectories are welcome). +and if you have all this then you probably know enough to +go ahead yourself :-) ** Something about Makefiles ------------------------------