Small correction: add WINDOWSLDLIBS when linking an executable.

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

diff --git a/docs/x11/install.txt b/docs/x11/install.txt
index 44e0c95391d2bb7da20c293257bfa01ac3d1d8bc..b9d30f03aef41415fe06ce22803cee3cc57cc41e 100644 (file)
--- a/docs/x11/install.txt
+++ b/docs/x11/install.txt
@@ -1,5 +1,5 @@
-wxWindows 2.3 for X11 installation
-------------------------------------
+wxWindows 2.5 for X11 installation
+----------------------------------

 
 IMPORTANT NOTE:
 
 
 IMPORTANT NOTE:
 


@@ -8,15 +8,15 @@ IMPORTANT NOTE:
   osname.txt for your platform if it exists) carefully before
   mailing wxwin-users or the author. Preferably, try to fix the
   problem first and then send a patch to the author.
   osname.txt for your platform if it exists) carefully before
   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 
   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: wxX11 2.3.0, egcs 1.1.1, Redhat 5.0
+  example: wxX11 2.5.0, gcc 2.95.4, Redhat 6.2

 
 First steps
 -----------
 
 
 First steps
 -----------
 

-- Download wxWindows-X-x.y.z.tgz, where x.y.z is the version number.
+- Download wxX11-x.y.z.tgz, where x.y.z is the version number.

   Download documentation in a preferred format, such as
   wxWindows-HTML.zip or wxWindows-PDF.zip.
 
   Download documentation in a preferred format, such as
   wxWindows-HTML.zip or wxWindows-PDF.zip.
 


@@ -37,8 +37,8 @@ First steps
 COMPILING USING CONFIGURE
 =========================
 
 COMPILING USING CONFIGURE
 =========================
 

-* The most simple case
------------------------
+* The simplest case
+-------------------

 
 If you compile wxWindows on Linux 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):


@@ -70,17 +70,19 @@ If you want to remove wxWindows on Unix you can do this:
 
 If you want to do some more serious cross-platform programming with wxWindows, 
 such as for GTK and X11, you can now build two complete libraries and use 
 
 If you want to do some more serious cross-platform programming with wxWindows, 
 such as for GTK and X11, you can now build two complete libraries and use 

-them concurretly. For this end, you have to create a directory for each build 
+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
 and test them concurrently. Most typically, this would be a version configured 
 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.
+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 X11 and a debug version of the GTK 
 source) you'd do this:
 
 md buildx11
 cd buildx11
 For building three versions (one GTK, one X11 and a debug version of the GTK 
 source) you'd do this:
 
 md buildx11
 cd buildx11

-../configure --with-x11 --with-universal
+../configure --with-x11

 make
 cd ..
 
 make
 cd ..
 


@@ -96,91 +98,81 @@ cd buildgtkd
 make
 cd ..
 
 make
 cd ..
 

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

 
 

-If there is just any way for you to use egcs, use egcs. We cannot fix gcc.
+You get errors during compilation: The reason is that you probably have a
+broken compiler.  GCC 2.8 and earlier versions and egcs are likely to cause
+problems due to incomplete support for C++ and optimisation bugs.  Best to use
+GCC 2.95 or later.

 
 

-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.
+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 compiler with optimisation
+bugs.

 
 

-* The most simple program
--------------------------
+* The simplest program
+----------------------

 
 

-Now create your super-application myfoo.app and compile anywhere with
+Now create your super-application myfoo.cpp and compile anywhere with

 
 

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

 
 * General
 
 * 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.

 
 

-If you have general problems with installation, read my homepage at 
+If you have general problems with installation, see the wxWindows website at 

 
 

-  http://wesley.informatik.uni-freiburg.de/~wxxt
+  http://www.wxwindows.org/

   
 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 
   
 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 
+YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF X, WHAT DISTRIBUTION 

 YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
 
 * GUI libraries
 YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
 
 * GUI libraries

------------------------
-
-wxWindows/X11 requires the X11 library to be installed on your system. As
-an alternative, you may also use the free library "lesstif" which implements
-most of the X11 API without the licence restrictions of X11.
-
-You can get the newest version of the Lesstif from the lesstif homepage at:
+---------------

 
 

-  http://www.lesstif.org
+wxWindows/X11 requires the X11 library to be installed on your system.

   
 * Additional libraries
   
 * Additional libraries

------------------------
+----------------------

 
 

-wxWindows/X11 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:
+wxWindows/X11 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
 
  - RedHat 5.1

- - Debian 2.0
+ - Debian 2.0 and 3.0

  - Stampede
  - DLD 6.0
  - SuSE 6.0
  
 You can disable thread support by running 
 
  - Stampede
  - DLD 6.0
  - SuSE 6.0
  
 You can disable thread support by running 
 

-./configure "--disable-threads"
+./configure --disable-threads

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

-NB: DO NOT COMPILE WXGTK WITH GCC AND THREADS, SINCE ALL PROGRAMS WILL
-CRASH UPON START-UP! Just always use egcs and be happy.
-
-* Building wxGTK on OS/2
---------------------------
+* Building wxX11 on OS/2
+------------------------

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

-Lesstif (0.89.1 or newer), emx (0.9d fix 1), flex (2.5.4),
-yacc (1.8), unix like shell, e.g. korn shell (5.2.13),
-Autoconf (2.13),  GNU file utilities (3.6),
+emx (0.9d fix 1), flex (2.5.4), yacc (1.8), unix like shell,
+e.g. 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).
 


@@ -200,7 +192,7 @@ versions of the configure scripts. Now run
     configure --with-x11
 as described above.
 
     configure --with-x11
 as described above.
 

-To verify Lesstif installation, configure will try to compile a
+To verify X11 installation, configure will try to compile a

 sample program that requires X headers/libraries to be either
 available via C_INCLUDE_PATH and LIBRARY_PATH or you need to
 explicitly set CFLAGS prior to running configure.
 sample program that requires X headers/libraries to be either
 available via C_INCLUDE_PATH and LIBRARY_PATH or you need to
 explicitly set CFLAGS prior to running configure.


@@ -214,7 +206,7 @@ generate "lex.yy.c", you need to manually change the generated
 makefile.
 
 * Building wxX11 on SGI
 makefile.
 
 * Building wxX11 on SGI

---------------------------
+-----------------------

 
 Using the SGI native compilers, it is recommended that you
 also set CFLAGS and CXXFLAGS before running configure. These 
 
 Using the SGI native compilers, it is recommended that you
 also set CFLAGS and CXXFLAGS before running configure. These 


@@ -232,17 +224,17 @@ untested).
 The SGI native compiler support has only been tested on Irix 6.5.
 
 * Create your configuration
 The SGI native compiler support has only been tested on Irix 6.5.
 
 * Create your configuration

------------------------------
+---------------------------

 
 Usage:
 
 Usage:

-       ./configure options
+       ./configure [options]

 
 If you want to use system's C and C++ compiler,
 set environment variables CXX and CC as
 
        % setenv CC cc
        % setenv CXX CC
 
 If you want to use system's C and C++ compiler,
 set environment variables CXX and CC as
 
        % setenv CC cc
        % setenv CXX CC

-       % ./configure options
+       % ./configure [options]

 
 to see all the options please use:
 
 
 to see all the options please use:
 


@@ -263,23 +255,16 @@ not been defined. And Make in some circumstances as well...
 
 
 * General options
 
 
 * 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.
 
 
 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).
-

 You have to add --with-x11 on platforms, where X11 is
 You have to add --with-x11 on platforms, where X11 is

-not the default (on Linux, configure will deafult to GTK).
+not the default (on Linux, configure will default to GTK).

 
 

-    --without-gtk            Don't use the GIMP ToolKit (GTK).
-       
-       --with-x11               Use X11.
-
-       --with-universal         Needs to be specified with X11.
+       --with-x11              Use X11.

 
 The following options handle the kind of library you want to build.
 
 
 The following options handle the kind of library you want to build.
 


@@ -312,9 +297,10 @@ The following options handle the kind of library you want to build.
        --enable-no_deps        Enable compilation without creation of
                                dependency information.
                                
        --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-permissive     Enable compilation without checking for strict
+                                ANSI conformance.  Useful to prevent the build
+                                dying with errors as soon as you compile with
+                                Solaris' ANSI-defying headers.

                                
        --enable-mem_tracing    Add built-in memory tracing. 
                                
                                
        --enable-mem_tracing    Add built-in memory tracing. 
                                


@@ -334,12 +320,12 @@ The following options handle the kind of library you want to build.
                                options.
 
 * Feature Options
                                options.
 
 * Feature Options

--------------------
+-----------------

 
 

-Many of the confiugre options have been thoroughly tested
+Many of the configure options have been thoroughly tested

 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 in wxWindows snapshot 6, but not yet all (ODBC not).
 

-When producing an executable that is linked statically with wxGTK
+When producing an executable that is linked statically with wxX11

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


@@ -363,7 +349,7 @@ are
        
        --disable-clipboard     Disables Clipboard.
        
        
        --disable-clipboard     Disables Clipboard.
        

-       --disable-serial        Disables object instance serialiasation.
+       --disable-serial        Disables object instance serialisation.

        
        --disable-streams       Disables the wxStream classes.
        
        
        --disable-streams       Disables the wxStream classes.
        


@@ -382,10 +368,10 @@ the program of its debugging information resulting in a significant
 reduction in size.
 
 * Compiling
 reduction in size.
 
 * Compiling

--------------
+-----------

 
 

-The following must be done in the base directory (e.g. ~/wxGTK
-or ~/wxWin or whatever)
+The following must be done in the base directory (e.g. ~/wxX11
+or whatever)

 
 Now the makefiles are created (by configure) and you can compile 
 the library by typing:
 
 Now the makefiles are created (by configure) and you can compile 
 the library by typing:


@@ -397,9 +383,9 @@ make yourself some coffee, as it will take some time. On an old
 warning messages depending in your compiler.
 
 If you want to be more selective, you can change into a specific
 warning messages depending in your compiler.
 
 If you want to be more selective, you can change into a specific

-directiry and type "make" there.
+directory and type "make" there.

 
 

-Then you may install the library and it's header files under
+Then you may install the library and its 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
 /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


@@ -413,17 +399,17 @@ 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.
 
 * Creating a new Project
 
 in the various directories will do the work for you.
 
 * Creating a new Project

---------------------------
+------------------------

 
 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
+g++ myfoo.cpp `wx-config --libs` `wx-config --cxxflags` -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


@@ -434,13 +420,13 @@ minimal: minimal.o
     $(CXX) -o minimal minimal.o `wx-config --libs` 
 
 minimal.o: minimal.cpp mondrian.xpm
     $(CXX) -o minimal minimal.o `wx-config --libs` 
 
 minimal.o: minimal.cpp mondrian.xpm

-    $(CXX) `wx-config --cflags` -c minimal.cpp -o minimal.o
+    $(CXX) `wx-config --cxxflags` -c minimal.cpp -o minimal.o

 
 clean: 
        rm -f *.o minimal
 
 This is certain to become the standard way unless we decide
 
 clean: 
        rm -f *.o minimal
 
 This is certain to become the standard way unless we decide

-to sitch to tmake.
+to stick 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


@@ -449,7 +435,7 @@ to the bottom of the configure.in script and run autoconf
 and configure before you can type make.
 
 * Further notes by Julian Smart
 and configure before you can type make.
 
 * Further notes by Julian Smart

----------------------------------
+-------------------------------

 
 - You may find the following script useful for compiling wxX11,
   especially if installing from zips (which don't preserve file
 
 - You may find the following script useful for compiling wxX11,
   especially if installing from zips (which don't preserve file


@@ -467,7 +453,7 @@ and configure before you can type make.
   # anyhow
   # -- Julian Smart
   chmod a+x configure config.sub config.guess
   # anyhow
   # -- Julian Smart
   chmod a+x configure config.sub config.guess

-  ./configure --with-shared --with-x11 --with-universal --without-gtk --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc
+  ./configure --with-x11 --with-shared --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc

   make
   -------:x-----Cut here-----:x-----
 
   make
   -------:x-----Cut here-----:x-----
 


@@ -477,9 +463,9 @@ and configure before you can type make.
 Troubleshooting
 ---------------
 
 Troubleshooting
 ---------------
 

-- Solaris compilation with gcc: if the compiler has problems with the variable argument
-  functions, try putting the gcc fixinclude file paths early in the include
-  path.
+- Solaris compilation with gcc: if the compiler has problems with the variable
+  argument functions, try putting the gcc fixinclude file paths early in the
+  include path.

 
 - If you operator-related compile errors or strange memory problems
   (for example in deletion of string arrays), set wxUSE_GLOBAL_MEMORY_OPERATORS
 
 - If you operator-related compile errors or strange memory problems
   (for example in deletion of string arrays), set wxUSE_GLOBAL_MEMORY_OPERATORS


@@ -500,7 +486,7 @@ Other Notes
   recommended to use --with-debug_info and --with-debug_flag configure
   switches while developing your application. To compile in non-debug
   mode, remove the -D__WXDEBUG__ switch in make.env (or if using the
   recommended to use --with-debug_info and --with-debug_flag configure
   switches while developing your application. To compile in non-debug
   mode, remove the -D__WXDEBUG__ switch in make.env (or if using the

-  configure system, change --with-debug_flag to --without_debug_flag
+  configure system, change --with-debug_flag to --without-debug_flag

   and --with-debug_info to --without-debug_info in the makewxx11
   script).
 
   and --with-debug_info to --without-debug_info in the makewxx11
   script).