Use UTF16 for text data object on Mac. Fixes #10902

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

diff --git a/docs/gtk/install.txt b/docs/gtk/install.txt
index 168a270a2b08e2425a4674a6d05f1884a8855031..3679ccbe1b3e972e7f500076e68d6824a4a72e78 100644 (file)
--- a/docs/gtk/install.txt
+++ b/docs/gtk/install.txt
@@ -1,5 +1,5 @@
-wxWindows 2.3 for GTK installation
-----------------------------------
+wxWidgets for GTK+ installation
+-------------------------------

 
 IMPORTANT NOTE:
 
 
 IMPORTANT NOTE:
 


@@ -9,88 +9,88 @@ IMPORTANT NOTE:
   mailing wxwin-users or the author. Preferably, try to fix the
   problem first and then send a patch to the author.
 
   mailing wxwin-users or the author. Preferably, try to fix the
   problem first and then send a patch to the author.
 

-  When sending bug reports tell us what version of wxWindows you are
+  When sending bug reports tell us what version of wxWidgets you are

   using (including the beta) and what compiler on what system. One
   using (including the beta) and what compiler on what system. One

-  example: wxGTK 2.3.3, gcc 2.95.4, Redhat 6.2
+  example: wxGTK 2.8.0, gcc 3.4.5, Fedora Core 4

 
 * The simplest case
 -------------------
 
 
 * The simplest case
 -------------------
 

-If you compile wxWindows on Linux for the first time and don't like to read
+If you compile wxWidgets 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 --with-gtk
+> mkdir buildgtk
+> cd buildgtk
+> ../configure --with-gtk

 > make
 > su <type root password>
 > make install
 > ldconfig
 > make
 > su <type root password>
 > make install
 > ldconfig

-> exit
+[if you get "ldconfig: command not found", try using "/sbin/ldconfig"]

 
 

-Afterwards you can continue with
+If you don't do the 'make install' part, you can still use the libraries from
+the buildgtk directory, but they may not be available to other users.

 
 

-> 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 wxWidgets on Unix you can do this:

 
 > su <type root password>
 > make uninstall
 > ldconfig
 
 > su <type root password>
 > make uninstall
 > ldconfig

-> exit
+
+Note that by default, GTK+ 2.X is used. GTK+ 1.2 can be specified
+with --with-gtk=1.

 
 * The expert case
 -----------------
 
 
 * 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 concurrently. For this end, you have to create a directory for each build
-of wxWindows - you may also want to create different versions of wxWindows
+If you want to do some more serious cross-platform programming with wxWidgets,
+such as for GTK+ and Motif, you can now build two complete libraries and use
+them concurrently. To do this, create a separate directory for each build
+of wxWidgets - you may also want to create different versions of wxWidgets

 and test them concurrently. Most typically, this would be a version configured
 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.
+with --enable-debug and one without.

 
 

-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:
 
 source) you'd do this:
 

-md buildmotif
+mkdir buildmotif

 cd buildmotif
 ../configure --with-motif
 make
 cd ..
 
 cd buildmotif
 ../configure --with-motif
 make
 cd ..
 

-md buildgtk
+mkdir buildgtk

 cd buildgtk
 ../configure --with-gtk
 make
 cd ..
 
 cd buildgtk
 ../configure --with-gtk
 make
 cd ..
 

-md buildgtkd
+mkdir buildgtkd

 cd buildgtkd
 cd buildgtkd

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

 make
 cd ..
 
 make
 cd ..
 

+Note that you can install all those libraries concurrently, you just need to
+pass the appropriate flags when using them.
+

 * The simplest errors
 ---------------------
 
 For any configure errors: please look at config.log file which was generated
 during configure run, it usually contains some useful information.
 
 * The simplest errors
 ---------------------
 
 For any configure errors: please look at config.log file which was generated
 during configure run, it usually contains some useful information.
 

-configure reports, that you don't have GTK 1.2 installed although you are
+configure reports, that you don't have GTK+ 1.2/2.0 installed although you are

 very sure you have. Well, you have installed it, but you also have another
 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
+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 a non-default

 location and configure can't find it there, so please check that your PATH
 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.
+variable includes the path to the correct gtk-config/pkg-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.

 
 You get errors from make: please use GNU make instead of the native make
 
 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
+program. Currently wxWidgets 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).
 
 Solaris make. Other versions might work or not (any which don't have VPATH
 support definitely won't).
 


@@ -105,9 +105,6 @@ your program - typically you might have the __WXDEBUG__ option set for the
 library but not for your program - or due to using a compiler with optimisation
 bugs.
 
 library but not for your program - or due to using a compiler with optimisation
 bugs.
 

-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 simplest program
 ----------------------
 
 * The simplest program
 ----------------------
 


@@ -115,30 +112,15 @@ Now create your super-application myfoo.cpp and compile anywhere with
 
 g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
 
 
 g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
 

-* General
----------
-
-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
-
-  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 YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect,
-but I tried...
-

 * GUI libraries
 ---------------
 
 * GUI libraries
 ---------------
 

-wxWindows/GTK requires the GTK+ library to be installed on your system. It has
-to be a stable version, preferably version 1.2.10 (at least 1.2.3 is required,
-1.2.7 is strongly recommended).
+wxWidgets/GTK+ requires the GTK+ library to be installed on your system. It has
+to be a stable version, preferably GTK+ 2.x.y, where x is an even number.
+GTK+ version 1.2 is highly discouraged, but if you decide to still use it,
+please use 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:
+You can get the newest version of the GTK+ from the GTK+ homepage at:

 
   http://www.gtk.org
 
 
   http://www.gtk.org
 


@@ -148,17 +130,11 @@ at my homepage.
 * Additional libraries
 ----------------------
 
 * Additional libraries
 ----------------------
 

-wxWindows/Gtk requires a thread library and X libraries known to work with
+wxWidgets/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
 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 and 3.0
- - Stampede
- - DLD 6.0
- - SuSE 6.0
+many aspects. As of writing this, virtually all Linux distributions have
+correct glibc 2 support.

 
 You can disable thread support by running
 
 
 You can disable thread support by running
 


@@ -173,39 +149,38 @@ exit
 ------------------------
 
 Please send comments and question about the OS/2 installation
 ------------------------
 
 Please send comments and question about the OS/2 installation

-to Andrea Venturoli <a.ventu@flashnet.it> 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),
-sed (2.05), grep (2.0), Awk (3.0.3), GNU Make (3.76.1).
+to Stefan Neis <Stefan.Neis@t-online.de> and patches to
+the wxWidgets mailing list.

 
 

-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__
-SET CFLAGS=-Zmtd -D__ST_MT_ERRNO__
-SET OSTYPE=OS2X
-SET COMSPEC=sh
+In the following list, the version numbers indicate the configuration that
+was actually used by myself, newer version should cause no problems and
+even older ones are expected to work most of the time.

 
 

-Notice you can choose whatever you want, if you don't like OS2X.
+You'll need OS/2 Warp (4.51) or eCS(1.0), X-Free86/2 (3.3.6 or newer),
+GTK+ (1.2.5 or newer), emx (0.9d fix 4), a Unix like shell (pdksh-5.2.14 or
+ash), Autoconf (2.57), GNU file utilities (3.13), GNU text utilities (1.19),
+GNU shell utilites (1.12), m4 (1.4), sed (2.05), grep (2.0), Awk (3.0.3),
+GNU Make (3.75).

 
 

-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.
+Preferably, you should have Posix/2 installed and C(PLUS)_INCLUDE_PATH and
+LIBRARY_PATH set up accordingly, however, wxGTK will even work without it.
+Presence of Posix/2 will be auto-detected.

 
 

-If you have pthreads library installed, but have a gtk version
-which does not yet support threading, you need to explicitly
-disable 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.
+Open an OS/2 prompt and switch to the directory above.
+Set MAKESHELL or MAKE_SHELL (which one is needed depends on the version of
+make) to a Unix like shell, e.g.
+SET MAKESHELL=ash
+If you have a really deficient version of GNU make, it might even be
+necessary to set SHELL or even COMSPEC to a unix like shell as well. 
+Depending on your installation you might want to also set INSTALL, for me
+it tends to try to use the system's tcpip\pcomos\install.exe which causes
+problems, e.g.
+SET INSTALL=<path_to_src_directory>/install-sh -c
+
+Notice that the delivered configure scripts are fully OS/2 aware, so you
+can simply run
+    ash -c "configure --with-gtk=1"
+and make and possibly make install as described above.

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


@@ -225,6 +200,20 @@ untested).
 
 The SGI native compiler support has only been tested on Irix 6.5.
 
 
 The SGI native compiler support has only been tested on Irix 6.5.
 

+* Building wxGTK on Cygwin
+--------------------------
+
+The normal build instructions should work fine on Cygwin. The one difference
+with Cygwin is that when using the "--enable-shared" configure option (which
+is the default) the API is exported explicitly using __declspec(dllexport)
+rather than all global symbols being available.
+
+This shouldn't make a difference using the library and should be a little
+more efficient. However if an export attribute has been missed somewhere you
+will see linking errors. If this happens then you can work around the
+problem by setting LDFLAGS=-Wl,--export-all-symbols. Please also let us know
+about it on the wx-dev mailing list.
+

 * Create your configuration
 ---------------------------
 
 * Create your configuration
 ---------------------------
 


@@ -232,7 +221,7 @@ Usage:
     ./configure options
 
 If you want to use system's C and C++ compiler,
     ./configure options
 
 If you want to use system's C and C++ compiler,

-set environment variables CC and CCC as
+set environment variables CC and CXX as

 
     % setenv CC cc
     % setenv CXX CC
 
     % setenv CC cc
     % setenv CXX CC


@@ -242,8 +231,8 @@ to see all the options please use:
 
     ./configure --help
 
 
     ./configure --help
 

-It is recommended to build wxWindows in another directory (maybe a
-subdirectory of your wxWindows installation) as this allows you to
+It is recommended to build wxWidgets in another directory (maybe a
+subdirectory of your wxWidgets installation) as this allows you to

 have multiple configurations (for example, debug and release or GTK
 and Motif) simultaneously.
 
 have multiple configurations (for example, debug and release or GTK
 and Motif) simultaneously.
 


@@ -257,11 +246,11 @@ 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
 
 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 SVN repository you have to choose a

 toolkit. You must do this by running configure with either of:
 
 toolkit. You must do this by running configure with either of:
 

-    --with-gtk              Use the GIMP ToolKit (GTK). Default.
-
+    --with-gtk=2            Use the GTK+ 2.0. Default.
+    --with-gtk=1            Use the GTK+ 1.2.

     --with-motif            Use either Motif or Lesstif
                             Configure will look for both.
 
     --with-motif            Use either Motif or Lesstif
                             Configure will look for both.
 


@@ -272,12 +261,18 @@ The following options handle the kind of library you want to build.
     --disable-shared        Do not create shared libraries, but
                             build static libraries instead.
 
     --disable-shared        Do not create shared libraries, but
                             build static libraries instead.
 

+    --enable-monolithic     Build wxWidgets as single library instead
+                            of as several smaller libraries (which is
+                            the default since wxWidgets 2.5.0).
+

     --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.
 
     --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-unicode        Enable Unicode support.
+

     --enable-profile        Add profiling info to the object
                             files. Currently broken, I think.
 
     --enable-profile        Add profiling info to the object
                             files. Currently broken, I think.
 


@@ -310,26 +305,32 @@ The following options handle the kind of library you want to build.
                             such as gdb (or its many frontends).
 
     --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
                             such as gdb (or its many frontends).
 
     --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when

-                            compiling. This enable wxWindows' very
+                            compiling. This enable wxWidgets' 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.
 
                             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.
 

+    --enable-debug          Same as --enable-debug_info and
+                            --enable-debug_flag together. Unless you have
+                            some very specific needs, you should use this
+                            option instead of --enable-debug_info/flag ones
+                            separately.
+

 * Feature Options
 -----------------
 
 When producing an executable that is linked statically with wxGTK
 you'll be surprised at its immense size. This can sometimes be
 * Feature Options
 -----------------
 
 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 wxWidgets that

 are not used in your program. The most relevant such features
 are
 
     --with-odbc             Enables ODBC code. This is disabled
                             by default because iODBC is under the
                             L-GPL license which is less liberal than
 are not used in your program. The most relevant such features
 are
 
     --with-odbc             Enables ODBC code. This is disabled
                             by default because iODBC is under the
                             L-GPL license which is less liberal than

-                            wxWindows license.
+                            wxWidgets license.

 
     --without-libpng        Disables PNG image format code.
 
 
     --without-libpng        Disables PNG image format code.
 


@@ -337,6 +338,8 @@ are
 
     --without-libtiff       Disables TIFF image format code.
 
 
     --without-libtiff       Disables TIFF image format code.
 

+    --without-expat         Disable XML classes based on Expat parser.
+

     --disable-pnm           Disables PNM image format code.
 
     --disable-gif           Disables GIF image format code.
     --disable-pnm           Disables PNM image format code.
 
     --disable-gif           Disables GIF image format code.


@@ -373,6 +376,10 @@ Apart from disabling certain features you can very often "strip"
 the program of its debugging information resulting in a significant
 reduction in size.
 
 the program of its debugging information resulting in a significant
 reduction in size.
 

+Please see the output of "./configure --help" for comprehensive list
+of all configurable options.
+
+

 * Compiling
 -----------
 
 * Compiling
 -----------
 


@@ -398,7 +405,7 @@ password) and type
 
         make install
 
 
         make install
 

-You can remove any traces of wxWindows by typing
+You can remove any traces of wxWidgets by typing

 
         make uninstall
 
 
         make uninstall
 


@@ -431,11 +438,14 @@ minimal.o: minimal.cpp mondrian.xpm
 clean:
        rm -f *.o minimal
 
 clean:
        rm -f *.o minimal
 

-This is certain to become the standard way unless we decide
-to stick to tmake.
+If your application uses only some of wxWidgets libraries, you can
+specify required libraries when running wx-config. For example,
+`wx-config --libs=html,core` will only output link command to link
+with libraries required by core GUI classes and wxHTML classes. See
+the manual for more information on the libraries.

 
 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
+directories of wxWidgets. 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
 and configure before you can type make.
 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.