+
+ !!! 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 Linux for the first time and don't like to read
+install instructions just do (in the base dir):
+
+> ./configure --with-gtk
+> make
+> su <type root password>
+> make install
+> ldconfig
+> exit
+
+Afterwards you can continue with
+
+> make
+> 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 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
+source) you'd do this:
+
+md buildmotif
+cd buildmotif
+../configure --with-motif
+make
+cd ..
+
+md buildgtk
+cd buildgtk
+../configure --with-gtk
+make
+cd ..
-./configure --without-threads
+md buildgtkd
+cd buildgtkd
+../configure --with-gtk --enable-debug_flag
make
+cd ..
-and drink 10 coffees. Then you may log in as root and type
+* The most simple errors
+------------------------
-make install
+configure reports, that you don't have GTK 1.X 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.
-You can leave out the --without-threads option if you have a NEW
-Linux distribution based on glibc (e.g. RedHat 5.1) or any other
-Unix that comes with Posix threads or SGI threads.
+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 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
-----------------------
-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, albeit 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:
-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.0.6 at my ftp site. 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:
+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:
- 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:
+ - RedHat 5.1
+ - Debian 2.0
+ - Stampede
+ - DLD 6.0
+ - SuSE 6.0
+
+You can disable thread support by running
- Requires Python. Soon to come.
+./configure "--disable-threads"
+make
+su <type root password>
+make install
+ldconfig
+exit
-* Other things 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.
-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.
+* Building wxGTK on OS/2
+--------------------------
-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.
+Please send comments and question about the OS/2 installation
+to Andrea Venturoli <a.ventu@flashnet.it> and patches to
+make the installation work (better) to me (Robert Roebling).
+You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3),
+gtk+ (?), emx (0.9d fix 1), flex (2.5.4), yacc (1.8),
+korn shell (5.2.13), Autoconf (?), 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).
-* Create your configuration
------------------------------
+Open an OS/2 prompt and switch to the directory above.
+First set some global environment variables we need:
-Usage:
- ./configure options
+SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__
+SET OSTYPE=OS2X
+SET COMSPEC=sh
-If you want to use system's C and C++ compiler,
-set environment variables CC and CCC as
+Notice you can choose whatever you want, if you don't like OS2X.
- % setenv CC cc
- % setenv CCC CC
- % ./configure options
+* Building wxGTK on SGI
+--------------------------
Using the SGI native compilers, it is recommended that you
also set CFLAGS and CXXFLAGS before running configure. These
The SGI native compiler support has only been tested on Irix 6.5.
+* Create your configuration
+-----------------------------
+
+Usage:
+ ./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
+
to see all the options please use:
./configure --help
* General options
-------------------
+Given below are the commands to change the default behaviour,
+i.e. if it says "--disable-threads" it means that threads
+are enabled by default.
+
+Many of the confiugre options have been thoroughly tested
+in wxWindows snapshot 6, but not yet all (ODBC not).
+
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
+ --without-gtk Don't use the GIMP ToolKit (GTK)
--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-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
+ binary size. Also fewer crashes during the
+ actual compilation...
- --with-dmalloc Use the dmalloc memory debugger.
+ --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/
- --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.
+Many of the confiugre options have been thoroughly tested
+in wxWindows snapshot 6, but not yet all (ODBC not).
+
+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. Not yet. }
+
+ --disable-resources 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.
+
+ --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.
* Compiling
-------------
The following must be done in the base directory (e.g. ~/wxGTK
or ~/wxWin or whatever)
-Dependencies are generated automatically using
-
- make depend
-
-(For some reason, this doesn't seem to work.)
-
-Now the makefiles are created you can compile everything is as simple
-as 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.
-
-if you want to be more selective:
+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.
- 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
+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
-"local" binaries and libraries will be placed in:
+You can remove any traces of wxWindows by typing
- (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
--------------------------
-There are two ways to create your own project:
-
1) The first way uses the installed libraries and header files
automatically using wx-config
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
+GNU libtool version 1.3
-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).
-
-
-** Something about Makefiles
-------------------------------
-
-On general principle it should only contain ONE line, which is as follows:
-
- include ../../setup/general/makeapp
-
-this will include all the necessary definitions for creating the applications
-
-the only case where you might want to add another line is the following:
-this version of configure also supports creation of source archives of the
-application for easy distribution and updates to newer version of wxWindows.
- For this purpose all files in the application-directory will be put into
-a gziped tar-file in the full notation user/<your application>/*
-if you want to include some other files that you want "more visible", like
-a README.<yourApp> or a shell script for easy
-compilation/installation/distribution, then you have to add a variable
-
- DISTRIBUTE_ADDITIONAL=<your files>
-
-to the Makefile.
-So it would look like this:
-
- DISTRIBUTE_ADDITIONAL=README.TheApp
- include ../../setup/general/makeapp
-
-As we have already talked about distribution the command to create a
-distribution is:
-
- make distrib
-
-NOTE: If you are in the base directory of wxWindows it will create
-distribution packages for wxWindows as well as for all packages in the
-user directory.
- So if you want to create only packages for the files in user,
-then go to the directory other and type:
-
- make distrib
-
-or if you only want one application to be created then
-enter the specific directory and type there:
-make distrib
-
-All the distribution files will be put in the directory
-distrib at the base of the wxWindows-tree (where also configure
-and template.mak can be found).
-
-** Something about Makefile.in
---------------------------------
-
-As you have already seen with Makefile, configure makes a lot of use
-if the include statement in make to keep the Makefiles as simple as
-possible.
-
-So basically there are only variables to define and then a include command.
-Exception to this rule is if you have special rules for some stuff...
-These rules should go AFTER the include statement!!!
-
-so the general header looks like this:
-
- # wxWindows base directory
- WXBASEDIR=@WXBASEDIR@
- # set the OS type for compilation
- OS=@OS@
- # compile a library only
- RULE=bin
-
-and the general footer will look like this:
-
- # include the definitions now
- include ../../../template.mak
-
-the key variable is RULE, which defines what make should create
-in this directory.
-
-here are some examples:
-
- RULE description
- ===========================================================================
- bin creates a local binary (for a global binary prefix bin with g)
- additional variables needed:
- BIN_TARGET this gives the name of your application
- BIN_OBJ this gives the object files needed to
- link the application
- optional variables are:
- BIN_SRC this gives the list of c/c++ files for
- which dependencies will be checked.
- (This can be achieved with: make depend)
- BIN_LINK this gives commands for additional
- libraries needed to link the application
- ---------------------------------------------------------------------------
- bin2 creates two local binaries (for global binaries prefix bin2 with g)
- in addition to the variables specified above you MUST also
- provide the same variables with BIN2_ instead of BIN_
- ---------------------------------------------------------------------------
- lib creates a local library (for a global binary prefix bin with g)
- additional variables needed:
- LIB_TARGET this gives the name of your library
- LIB_OBJ this gives the object files needed for
- the library to be build.
- optional variables are:
- LIB_SRC this gives the list of c/c++ files for
- which dependencies will be checked.
- libbin and libgbin are also possible and will need in addition
- the variables from bin
- ---------------------------------------------------------------------------
- gslib is similar to lib, but it creates a shared library if the system
- supports it.
- additional variables needed:
- LIB_MAJOR major number of the shared library
- LIB_MINOR minor number of the shared library
- ---------------------------------------------------------------------------
- other additional variables:
-
- ADD_COMPILE define additional includes/defines that
- are needed to compile the object files
- (if you need to reference some directory
- utils - like wxGrid -, then please
- reference them with the variables defined
- in template.mak - e.g.: $(SRCDIR),$(UTILS),
- $(SAMPLES),$(OTHERS))
-
- NEEDED_DEFINES lists all the defines that HAVE to be set in
- /include/wx/setup.h to compile correctly.
-
- SRC_DIR lists all directories that are needed to
- compile. (i.e: lists all the directories,
- where there are source-files.) But it is
- also needed to clean an object and for
- machines, for which make does not support
- VPATH
-
-currently there are the following compiling rules provided:
-object files are created for the following file extensions:
-.c .cc .cpp
-
-Please have a closer look at the Makefiles in this distribution.
-
-* Platforms configure is working with
----------------------------------------
-
-Please report build succes on any machine. Especially non-
-Linux operating systems (which I don't have).
-
-Original author of the autoconf system for wxxt-1.66 and for this INSTALL
-file:
-
- Martin Sperl sperl@dsn.ast.univie.ac.at
-
-Ported to wxGTK 0.1:
+GNU make
+GNU C++
- Wolfram Gloger wmglo@dent.med.uni-muenchen.de
+and if you have all this then you probably know enough to
+go ahead yourself :-)
-Thanks alot to both of them.
+----------------------
In the hope that it will be useful,
- Robert Roebling roebling@sun2.ruf.uni-freiburg.de
+ Robert Roebling <roebling@sun2.ruf.uni-freiburg.de>
projects / wxWidgets.git / blobdiff