+
+ !!! 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):
-./configure --without-threads
+./configure
make
-
-and drink 10 coffees. Then you may log in as root and type
-
+su <type root password>
make install
+ldconfig
+exit
+
+If you want to remove wxWindows on Unix you can do this:
+
+su <type root password>
+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 ..
-You can leave out the --without-threads option if you have
-a NEW Linux distribution based on glibc (e.g. RedHat 5.1 or
-Debian 2.0) or any other Unix that comes with Posix threads
-or SGI threads.
+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` `wx-config --cflags` -o myfoo
+g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo
* General
-----------------------
-----------------------
wxWindows/GTK requires the GTK+ library to be installed on your system.
-It has to be a stable version, preferebly version 1.0.6. When using
-a version previous to 1.0.6 you'll get crashes here and there.
-
-wxWindows/GTK does NOT work with the 1.1.X versions of the GTK+ library
-and we will wait until the 1.2 version comes out and has stabilized
-until we'll work with that library.
+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
at
http://www.gtk.org
-We also mirror GTK+ 1.0.6 at our ftp site. You'll find information
+We also mirror GTK+ 1.2.1 at my ftp site soon. You'll find information
about downloading at my homepage.
* Additional libraries
- RedHat 5.1
- Debian 2.0
- Stampede
+ - DLD 6.0
+ - SuSE 6.0
-The next major version of SuSE will also support glibc 2,
-but version 5.X does not. Also Caldera and Slackware
-don't yet support glibc 2.
-
-On IRIX you can also use SGI threads if Posix-Threads
-are not present. The SGI threads will be detected by
-configure automatically.
+You can disable thread support by running
-You can always disable thread support by running
-
-./configure "--without-threads"
-make clean
+./configure "--disable-threads"
make
+su <type root password>
+make install
+ldconfig
+exit
-NB: I included thread support in wxWindows/Gtk, as this
-problem will disappear in the near future when all major
-Linux Variants have moved to glibc 2. Also, the Linux
-Base Standard will include glibc 2.
+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
-----------------------------
* General options
-------------------
+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
--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.
- --without-shared Do not 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
-------------------
-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. It is currently NOT possible to disable these
-options (in contrast to what configure tells you).
+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.
+
+ --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 whatever)
-Now the makefiles are created and you can compile everything
-by typing:
+Now the makefiles are created (by configure) and you can compile
+the library by typing:
make
-make yourself some coffee, as it will try to compile ALL the
-files in this distribution. During compilation, you'll get
-a few warning messages.
+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.
-if you want to be more selective:
-
- make src will build only the base libraries
- make samples will build the samples
- make other will build everything in other
- make user will build everything in user
+if you want to be more selective, you can change into a specific
+directiry and type "make" there.
Then you may install the library and it's header files under
/usr/local/include/wx and /usr/local/lib respectively. You
password) and type
make install
-
-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:
- bin/$(OSTYPE) and
- lib/$(OSTYPE) respectively
+You can remove any traces of wxWindows by typing
-"local" binaries and libraries will be placed in:
-
- (basedir of that application)/$(OSTYPE).
-
-This is also the place where all the object-files will go.
-
-If you want to conserve disk space by removing unnecessary
+ make uninstall
+
+If you want to save disk space by removing unnecessary
object-files:
- make clean_obj
+ make clean
-will do the work for you.
+in the various directories will do the work for you.
* Creating a new Project
--------------------------
to sitch to tmake.
2) The other way creates a project within the source code
-directories of wxWindows: In this case I propose to put
-all contributed programs in the directory "/user", with a
-directory of its own.
+directories of wxWindows. For this endeavour, you'll need
+the usual number of GNU tools, at least
-This directory then should include the following files:
+GNU automake version 1.4
+GNU autoheader version 2.14
+GNU autoconf version 2.14
-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)
+and quite possibly
-put ALL your source code along with all the other stuff you need for
-your application in this directory (subdirectories are welcome).
+GNU make
+GNU cc
+and if you have all this then you probably know enough to
+go ahead yourself :-)
** Something about Makefiles
------------------------------