Added wxQuantize, wxSplashScreen, wxEffects & added palette to wxImage

[wxWidgets.git] / docs / gtk / install.txt

diff --git a/docs/gtk/install.txt b/docs/gtk/install.txt
index 25b890d49a76abb1d665306fc033e19194667701..9c9a1f9cbb7b15d7fde772860a4a32fab84e6b72 100644 (file)
--- a/docs/gtk/install.txt
+++ b/docs/gtk/install.txt
@@ -1,27 +1,35 @@
 
   !!! 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.1 beta 6, egcs 1.1.1, Redhat 5.0 !!!
+      example: wxGTK 2.2.0, egcs 1.1.1, Redhat 6.2 !!!

 
 * The most simple case
 -----------------------
 
 
 * The most simple case
 -----------------------
 

-If you compile wxWindows on Unix 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):
 
 install instructions just do (in the base dir):
 

-./configure
-make
-su <type root password>
-make install
-ldconfig
-exit
+> ./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:
 
 
 If you want to remove wxWindows on Unix you can do this:
 

-su <type root password>
-make uninstall
-ldconfig
-exit
+> su <type root password>
+> make uninstall
+> ldconfig
+> exit

 
 * The expert case
 -----------------
 
 * The expert case
 -----------------


@@ -33,8 +41,8 @@ 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.
 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 version, one GTK, one Motif and a debug version of the GTK 
-source, you'd do this:
+For building three versions (one GTK, one Motif and a debug version of the GTK 
+source) you'd do this:

 
 md buildmotif
 cd buildmotif
 
 md buildmotif
 cd buildmotif


@@ -50,16 +58,16 @@ cd ..
 
 md buildgtkd
 cd buildgtkd
 
 md buildgtkd
 cd buildgtkd

-../configure --with-gtk --enable-debug
+../configure --with-gtk --enable-debug_flag

 make
 cd ..
 
 * The most simple errors
 ------------------------
 
 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 
+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 
 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 


@@ -82,7 +90,7 @@ program - or due to using a broken compiler (and its optimisation) such as GCC 2
 
 Now create your super-application myfoo.app and compile anywhere with
 
 
 Now create your super-application myfoo.app and compile anywhere with
 

-g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo
+gcc myfoo.cpp `wx-config --libs --cflags` -o myfoo

 
 * General
 -----------------------
 
 * General
 -----------------------


@@ -103,15 +111,13 @@ YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
 -----------------------
 
 wxWindows/GTK requires the GTK+ library to be installed on your system. It has to 
 -----------------------
 
 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.
+be a stable version, preferebly version 1.2.3.

 
 You can get the newest version of the GTK+ from the GTK homepage at:
 
   http://www.gtk.org
   
 
 You can get the newest version of the GTK+ from the GTK homepage at:
 
   http://www.gtk.org
   

-We also mirror GTK+ 1.2.1 at my ftp site soon. You'll find information about downloading 
+We also mirror GTK+ 1.2.3 at my ftp site. You'll find information about downloading 

 at my homepage.
   
 * Additional libraries
 at my homepage.
   
 * Additional libraries


@@ -137,7 +143,7 @@ make install
 ldconfig
 exit
   
 ldconfig
 exit
   

-NB: DO NOT COMPILE WXGTK WITH GCC 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
 START-UP! Just always use egcs and be happy.
 
 * Building wxGTK on OS/2


@@ -145,11 +151,11 @@ START-UP! Just always use egcs and be happy.
 
 Please send comments and question about the OS/2 installation
 to Andrea Venturoli <a.ventu@flashnet.it> and patches to
 
 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).
+the wxWindows mailing list.

 
 

-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), 
+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).
 
 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).
 


@@ -157,11 +163,27 @@ Open an OS/2 prompt and switch to the directory above.
 First set some global environment variables we need:
 
 SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__
 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 COMSPEC=sh
 
 Notice you can choose whatever you want, if you don't like OS2X.
 
 SET OSTYPE=OS2X              
 SET COMSPEC=sh
 
 Notice you can choose whatever you want, if you don't like OS2X.
 

+Now, run autoconf in the main directory and in the samples, demos
+and utils subdirectory. This will generate the OS/2 specific
+versions of the configure scripts. Now run
+    configure --with-gtk
+as described above.
+
+If you have pthreads library installed, but have a gtk version
+which does not yet support threading, you need to explicitly
+diable threading by using the option --disable-threads.
+
+Note that configure assumes your flex will generate files named
+"lexyy.c", not "lex.yy.c". If you have a version which does
+generate "lex.yy.c", you need to manually change the generated
+makefile.
+

 * Building wxGTK on SGI
 --------------------------
 
 * Building wxGTK on SGI
 --------------------------
 


@@ -214,46 +236,65 @@ not been defined. And Make in some circumstances as well...
 * General options
 -------------------
 
 * General options
 -------------------
 

-The confiugre options have not yet been thoroughly tested
-in wxWindows snapshot 6.
+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.

 
 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:
 
 
 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)
+    --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.
 
        
        --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. Threads
-                               support is also required for the
-                               socket code to work.
+       --disable-threads       Compile without thread support.

 
        --disable-shared        Do not create shared libraries.
 
 
        --disable-shared        Do not create shared libraries.
 

-       --disable-optimise      Do not optimise the code. Can
+       --enable-static         Create static libraries.
+
+       --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 
                                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.
+                                           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 
+                               binary size. Also fewer crashes during the
+                               actual compilation...
+                               
+       --enable-no_deps        Enable compilation without creation of
+                               dependency information.

                                
                                

-       --enable-mem_tracing    Add built-in memory tracing. 
+       --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-dmalloc        Use the dmalloc memory debugger.
                                Read more at www.letters.com/dmalloc/
                                

-       --enable-debug_info     Add debug info to object files and
+       --enable-debug_info         Add debug info to object files and

                                executables for use with debuggers
                                executables for use with debuggers

-                               such as gdb (or its many frontends).
+                                           such as gdb (or its many frontends).

 
 

-       --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
+       --enable-debug_flag         Define __DEBUG__ and __WXDEBUG__ when

                                compiling. This enable wxWindows' very
                                useful internal debugging tricks (such
                                as automatically reporting illegal calls)
                                compiling. This enable wxWindows' very
                                useful internal debugging tricks (such
                                as automatically reporting illegal calls)


@@ -264,22 +305,29 @@ The following options handle the kind of library you want to build.
 * Feature Options
 -------------------
 
 * Feature Options
 -------------------
 

-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
 
 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.
+       --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.

        
        

-       --without-libjpeg       Disables JPEG image format code.
+       --disable-gif               Disables GIF image format code.

        
        

-       --without-odbc          Disables ODBC code.
+       --disable-pcx               Disables PCX image format code.

        
        

-        --disable-wxresources   Disables the use of *.wxr type
+    --disable-resources     Disables the use of *.wxr type

                                resources.
                
        --disable-threads       Disables threads. Will also
                                resources.
                
        --disable-threads       Disables threads. Will also


@@ -295,6 +343,16 @@ are
        
        --disable-streams       Disables the wxStream classes.
        
        
        --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.
 Apart from disabling certain features you can very often "strip"
 the program of its debugging information resulting in a significant
 reduction in size.


@@ -314,7 +372,7 @@ 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.
 
 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
+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
 directiry and type "make" there.
 
 Then you may install the library and it's header files under


@@ -331,7 +389,7 @@ You can remove any traces of wxWindows by typing
 If you want to save disk space by removing unnecessary
 object-files:
 
 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.
 
 
 in the various directories will do the work for you.
 


@@ -341,12 +399,12 @@ in the various directories will do the work for you.
 1) The first way uses the installed libraries and header files
 automatically using wx-config
 
 1) The first way uses the installed libraries and header files
 automatically using wx-config
 

-g++ myfoo.cpp `wx-config --libs` `wx-config --cflags` -o myfoo
+gcc myfoo.cpp `wx-config --cflags --libs` -o myfoo

 
 Using this way, a make file for the minimal sample would look
 like this
 
 
 Using this way, a make file for the minimal sample would look
 like this
 

-CC = g++
+CC = gcc

 
 minimal: minimal.o
     $(CC) -o minimal minimal.o `wx-config --libs` 
 
 minimal: minimal.o
     $(CC) -o minimal minimal.o `wx-config --libs` 


@@ -362,24 +420,13 @@ to sitch to tmake.
 
 2) The other way creates a project within the source code 
 directories of wxWindows. For this endeavour, you'll need
 
 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
-
-GNU automake version 1.4
-GNU autoheader version 2.14
-GNU autoconf version 2.14
-
-and quite possibly 
-
-GNU make
-GNU cc
-
-and if you have all this then you probably know enough to
-go ahead yourself :-)
+GNU autoconf version 2.14 and add an entry to your Makefile.in
+to the bottom of the configure.in script and run autoconf
+and configure before you can type make.

 
 ----------------------
 
 In the hope that it will be useful,
 
 
 ----------------------
 
 In the hope that it will be useful,
 

-        Robert Roebling <roebling@sun2.ruf.uni-freiburg.de>
-       
-       
+        Robert Roebling
+