documented OnDrawBackground()

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

diff --git a/docs/motif/install.txt b/docs/motif/install.txt
index 2cbb7cb91d12978911eae1ff4e9a9ae46f294d44..8962f5c76292ddd9810214fe42998f17f114df3a 100644 (file)
--- a/docs/motif/install.txt
+++ b/docs/motif/install.txt
@@ -1,4 +1,4 @@
-wxWindows 2.3 for Motif installation
+wxWindows 2.5 for Motif installation

 ------------------------------------
 
 IMPORTANT NOTE:
 ------------------------------------
 
 IMPORTANT NOTE:


@@ -6,20 +6,21 @@ IMPORTANT NOTE:
   If you experience problems installing, please re-read these
   instructions and other related files (todo.txt, bugs.txt and
   osname.txt for your platform if it exists) carefully before
   If you experience problems installing, please re-read these
   instructions and other related files (todo.txt, bugs.txt and
   osname.txt for your platform if it exists) carefully before

-  mailing wxwin-users or the author. Preferably, try to fix the
+  mailing wx-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 
   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 

-  example: wxMotif 2.3.0, egcs 1.1.1, Redhat 5.0
+  example: wxMotif 2.5.0, gcc 2.95.4, Redhat 6.1

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

-- Prerequisites: Motif 1.2 or above, or Lesstif
-  (not yet tested). Motif 2.0 and above may also be suitable.
+- Prerequisites: Motif 1.2 or above, or Lesstif. Motif 2.0 and
+  above may also be suitable.

 
 

-- Download wxMotif-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.
+  (wxMotif is included in the wxX11 distribution).

   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.
 


@@ -33,7 +34,7 @@ First steps
 
 - You can now use configure to build wxWindows and the samples.
 
 
 - You can now use configure to build wxWindows and the samples.
 

-  Using configure is the recommended way to build the library. If it doesn't
+  Using configure is the only way to build the library. If it doesn't

   work for you for whatever reason, please report it (together with detailed
   information about your platform and the (relevant part of) contents of
   config.log file) to wx-dev@lists.wxwindows.org.
   work for you for whatever reason, please report it (together with detailed
   information about your platform and the (relevant part of) contents of
   config.log file) to wx-dev@lists.wxwindows.org.


@@ -42,8 +43,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):


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

-* 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.app 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 
   
 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...
+report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF
+YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF MOTIF, WXMOTIF, WHAT
+DISTRIBUTION YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect,
+but I tried...

 
 * GUI libraries
 
 * GUI libraries

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

 
 wxWindows/Motif requires the Motif library to be installed on your system. As
 an alternative, you may also use the free library "lesstif" which implements
 
 wxWindows/Motif requires the Motif library to be installed on your system. As
 an alternative, you may also use the free library "lesstif" which implements


@@ -147,35 +148,33 @@ most of the Motif API without the licence restrictions of Motif.
 
 You can get the newest version of the Lesstif from the lesstif homepage at:
 
 
 You can get the newest version of the Lesstif from the lesstif homepage at:
 

-  http://www.lesstif.org
+  http://www.lesstif.org/

   
 * Additional libraries
   
 * Additional libraries

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

 
 

-wxWindows/Motif 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/Motif 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 wxMotif on OS/2

 --------------------------
 
 Please send comments and question about the OS/2 installation
 --------------------------
 
 Please send comments and question about the OS/2 installation


@@ -219,7 +218,7 @@ generate "lex.yy.c", you need to manually change the generated
 makefile.
 
 * Building wxMotif on SGI
 makefile.
 
 * Building wxMotif 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 


@@ -237,10 +236,10 @@ 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
 
 If you want to use system's C and C++ compiler,
 set environment variables CXX and CC as


@@ -274,14 +273,12 @@ 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.
 
 i.e. if it says "--disable-threads" it means that threads
 are enabled by default.
 

-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).
 
 You have to add --with-motif on platforms, where Motif is
 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 You have to add --with-motif on platforms, where Motif 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-motif             Use either Motif or Lesstif
                                 Configure will look for both. 
 
        --with-motif             Use either Motif or Lesstif
                                 Configure will look for both. 
 


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

+       --enable-debug          Equivalent to --enable-debug_info plus
+                               --enable-debug-flag.
+

        --enable-debug_info     Add debug info to object files and
                                executables for use with debuggers
                                such as gdb (or its many frontends).
        --enable-debug_info     Add debug info to object files and
                                executables for use with debuggers
                                such as gdb (or its many frontends).


@@ -338,9 +339,9 @@ 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).
 
 When producing an executable that is linked statically with wxGTK
 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 When producing an executable that is linked statically with wxGTK


@@ -353,11 +354,8 @@ are
        
        --without-libjpeg       Disables JPEG image format code.
        
        
        --without-libjpeg       Disables JPEG image format code.
        

-{      --without-odbc          Disables ODBC code. Not yet. }
+       --without-odbc          Disables ODBC code.

        
        

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

        --disable-threads       Disables threads. Will also
                                disable sockets.
 
        --disable-threads       Disables threads. Will also
                                disable sockets.
 


@@ -367,8 +365,6 @@ are
        
        --disable-clipboard     Disables Clipboard.
        
        
        --disable-clipboard     Disables Clipboard.
        

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

        --disable-streams       Disables the wxStream classes.
        
        --disable-file          Disables the wxFile class.
        --disable-streams       Disables the wxStream classes.
        
        --disable-file          Disables the wxFile class.


@@ -386,9 +382,9 @@ 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
+The following must be done in the base directory (e.g. ~/wxMotif

 or ~/wxWin or whatever)
 
 Now the makefiles are created (by configure) and you can compile 
 or ~/wxWin or whatever)
 
 Now the makefiles are created (by configure) and you can compile 


@@ -397,13 +393,13 @@ the library by typing:
        make
 
 make yourself some coffee, as it will take some time. On an old
        make
 
 make yourself some coffee, as it will take some time. On an old

-386SX possibly two weeks. During compilation, you'll get a few 
+Pentium 200 around 40 minutes. During compilation, you may get a few 

 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


@@ -422,12 +418,12 @@ object-files:
 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


@@ -438,13 +434,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


@@ -471,7 +467,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-motif --without-gtk --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc
+  ./configure --with-shared --with-motif --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc

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


@@ -481,9 +477,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


@@ -505,14 +501,10 @@ Troubleshooting
 Other Notes
 -----------
 
 Other Notes
 -----------
 

-- Debugging mode is switched on by default in the makefiles, but using
-  configure will create a release build of the library by default: it's
-  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
-  and --with-debug_info to --without-debug_info in the makewxmotif
-  script).
+- Using configure will create a release build of the library by
+  default: it's recommended to use --enable-debug configure switch
+  while developing your application. To compile in non-debug mode, use
+  --disable-debug configure switch.

 
 Bug reports
 -----------
 
 Bug reports
 -----------