blind PCH-less build fixes: add missing headers

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

diff --git a/docs/motif/install.txt b/docs/motif/install.txt
index 984729779a86bb69bc72fbe4afb53a2bf2f22969..b8fc8d22fd6e88edb1d1db42c587cb29008245c4 100644 (file)
--- a/docs/motif/install.txt
+++ b/docs/motif/install.txt
@@ -1,5 +1,5 @@
-wxWindows 2.5 for Motif installation
-------------------------------------
+wxWidgets for Motif installation
+--------------------------------

 
 IMPORTANT NOTE:
 
 
 IMPORTANT NOTE:
 


@@ -9,9 +9,9 @@ IMPORTANT NOTE:
   mailing wx-users or the author. Preferably, try to fix the
   problem first and then send a patch to the author.
   
   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 
+  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: wxMotif 2.5.1, gcc 2.95.4, Redhat 6.1
+  example: wxMotif 2.8.1, gcc 2.95.4, Redhat 6.1

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


@@ -22,7 +22,7 @@ First steps
 - 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
 - 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.
+  wxWidgets-HTML.zip or wxWidgets-PDF.zip.

 
 - Make a directory such as ~/wx and unarchive the files into this
   directory.
 
 - Make a directory such as ~/wx and unarchive the files into this
   directory.


@@ -30,14 +30,14 @@ First steps
 - It is recommended that you install bison and flex; using yacc
   and lex may require tweaking of the makefiles. You also need
   libXpm (see comments in the Notes section below) if you want to have
 - It is recommended that you install bison and flex; using yacc
   and lex may require tweaking of the makefiles. You also need
   libXpm (see comments in the Notes section below) if you want to have

-  XPM support in wxWindows (recommended).
+  XPM support in wxWidgets (recommended).

 
 

-- You can now use configure to build wxWindows and the samples.
+- You can now use configure to build wxWidgets and the samples.

 
   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
 
   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.
+  config.log file) to wx-dev@lists.wxwidgets.org.

 
 
 COMPILING USING CONFIGURE
 
 
 COMPILING USING CONFIGURE


@@ -46,7 +46,7 @@ COMPILING USING CONFIGURE
 * 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):
 
 > ./configure --with-motif
 install instructions just do (in the base dir):
 
 > ./configure --with-motif


@@ -64,7 +64,7 @@ Afterwards you can continue with
 > ldconfig
 > exit
 
 > 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
 
 > su <type root password>
 > make uninstall


@@ -74,15 +74,15 @@ If you want to remove wxWindows on Unix you can do this:
 * The expert case
 -----------------
 
 * The expert case
 -----------------
 

-If you want to do some more serious cross-platform programming with 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. For this end, you have to create a directory for each build 
 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
+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 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.
+
+For building three versions (one GTK, one Motif and a debug version of the GTK
+source) you'd do this:

 
 mkdir buildmotif
 cd buildmotif
 
 mkdir buildmotif
 cd buildmotif


@@ -102,6 +102,9 @@ cd buildgtkd
 make
 cd ..
 
 make
 cd ..
 

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

 * The simplest errors
 ---------------------
 
 * The simplest errors
 ---------------------
 


@@ -126,12 +129,12 @@ g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
 * General
 ---------
 
 * General
 ---------
 

-The Unix variants of wxWindows use GNU configure. If you have problems with
+The Unix variants of wxWidgets use GNU configure. If you have problems with

 your make use GNU make instead.
 
 your make use GNU make instead.
 

-If you have general problems with installation, see the wxWindows website at 
+If you have general problems with installation, see the wxWidgets website at 

 
 

-  http://www.wxwindows.org/
+  http://www.wxwidgets.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


@@ -142,7 +145,7 @@ but I tried...
 * GUI libraries
 ---------------
 
 * GUI libraries
 ---------------
 

-wxWindows/Motif requires the Motif library to be installed on your system. As
+wxWidgets/Motif requires the Motif library to be installed on your system. As

 an alternative, you may also use the free library "lesstif" which implements
 most of the Motif API without the licence restrictions of Motif.
 
 an alternative, you may also use the free library "lesstif" which implements
 most of the Motif API without the licence restrictions of Motif.
 


@@ -153,7 +156,7 @@ You can get the newest version of the Lesstif from the lesstif homepage at:
 * Additional libraries
 ----------------------
 
 * Additional libraries
 ----------------------
 

-wxWindows/Motif requires a thread library and X libraries known to work with
+wxWidgets/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, virtually all Linux distributions have
 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, virtually all Linux distributions have


@@ -173,16 +176,15 @@ exit
 
 Please send comments and question about the OS/2 installation
 to Stefan Neis <Stefan.Neis@t-online.de> and patches to
 
 Please send comments and question about the OS/2 installation
 to Stefan Neis <Stefan.Neis@t-online.de> and patches to

-the wxWindows mailing list.
+the wxWidgets mailing list.

 
 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.
 
 You'll need OS/2 Warp (4.51) or eCS(1.0), X-Free86/2 (3.3.6 or newer),
 
 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.
 
 You'll need OS/2 Warp (4.51) or eCS(1.0), X-Free86/2 (3.3.6 or newer),

-Lesstif (0.92.7 or newer), emx (0.9d fix 4), flex (2.5.4), yacc (1.8) or
-bison (1.25), a Unix like shell (pdksh-5.2.14 or ash), Autoconf (2.57),
-GNU file utilities (3.13), GNU text utilities (1.19),
+Lesstif (0.92.7 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).
 
 GNU shell utilites (1.12), m4 (1.4), sed (2.05), grep (2.0), Awk (3.0.3),
 GNU Make (3.75).
 


@@ -191,15 +193,15 @@ LIBRARY_PATH set up accordingly, however, wxGTK will even work without it.
 Presence of Posix/2 will be auto-detected.
 
 Open an OS/2 prompt and switch to the directory above.
 Presence of Posix/2 will be auto-detected.
 
 Open an OS/2 prompt and switch to the directory above.

-Set MAKESHELL (and depending on your installation also INSTALL, for me
-it tends to try to use the system's tcpip\pcomos\install.exe which causes
-problems...) to a Unix like shell, e.g.
+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
 SET MAKESHELL=ash

-
-Be warned that depending on the precise version of your make, the
-variable that needs to be set might be MAKE_SHELL instead of MAKESHELL.

 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. 
 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
 
 Notice that the delivered configure scripts are fully OS/2 aware, so you
 can simply run


@@ -229,6 +231,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 wxMotif 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
 ---------------------------
 


@@ -268,7 +284,7 @@ i.e. if it says "--disable-threads" it means that threads
 are enabled by default.
 
 Many of the configure options have been thoroughly tested
 are enabled by default.
 
 Many of the configure options have been thoroughly tested

-in wxWindows snapshot 6, but not yet all (ODBC not).
+in wxWidgets 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 default to GTK).
 
 You have to add --with-motif on platforms, where Motif is
 not the default (on Linux, configure will default to GTK).


@@ -280,19 +296,19 @@ 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
 
        --disable-threads       Compile without thread support. Threads
                                support is also required for the

-                            socket code to work.
+                               socket code to work.

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

-    --enable-monolithic     Build wxWindows as single library instead
-                            of as several smaller libraries (which is
-                            the default since wxWindows 2.5.0).
+       --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
 
        --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.
+                               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.
 
        --enable-profile        Add profiling info to the object 
                                files. Currently broken, I think.


@@ -311,16 +327,16 @@ 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 checking for strict
-                                ANSI conformance.  Useful to prevent the build
-                                dying with errors 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. 

-                               
+

        --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          Equivalent to --enable-debug_info plus
                                --enable-debug-flag.
 
        --enable-debug          Equivalent to --enable-debug_info plus
                                --enable-debug-flag.
 


@@ -329,7 +345,7 @@ 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
                                useful internal debugging tricks (such
                                as automatically reporting illegal calls)
                                to work. Note that program and library


@@ -340,43 +356,43 @@ The following options handle the kind of library you want to build.
 -----------------
 
 Many of the configure 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 wxWidgets 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
 
 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
 
        --without-libpng        Disables PNG image format code.
 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-libjpeg       Disables JPEG image format code.

-       
+

        --without-odbc          Disables ODBC code.
        --without-odbc          Disables ODBC code.

-   
-    --without-libtiff       Disables TIFF image format code.
- 
-    --without-expat         Disable XML classes based on Expat parser.
-       
+
+       --without-libtiff       Disables TIFF image format code.
+
+       --without-expat         Disable XML classes based on Expat parser.
+

        --disable-threads       Disables threads. Will also
                                disable sockets.
 
        --disable-sockets       Disables sockets.
 
        --disable-dnd           Disables Drag'n'Drop.
        --disable-threads       Disables threads. Will also
                                disable sockets.
 
        --disable-sockets       Disables sockets.
 
        --disable-dnd           Disables Drag'n'Drop.

-       
+

        --disable-clipboard     Disables Clipboard.
        --disable-clipboard     Disables Clipboard.

-       
+

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

-       
+

        --disable-file          Disables the wxFile class.
        --disable-file          Disables the wxFile class.

-       
+

        --disable-textfile      Disables the wxTextFile class.
        --disable-textfile      Disables the wxTextFile class.

-       
+

        --disable-intl          Disables the internationalisation.
        --disable-intl          Disables the internationalisation.

-       
+

        --disable-validators    Disables validators.
        --disable-validators    Disables validators.

-       
+

        --disable-accel         Disables accel.
        
 Apart from disabling certain features you can very often "strip"
        --disable-accel         Disables accel.
        
 Apart from disabling certain features you can very often "strip"


@@ -412,7 +428,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
        


@@ -448,14 +464,14 @@ clean:
 This is certain to become the standard way unless we decide
 to stick to tmake.
 
 This is certain to become the standard way unless we decide
 to stick to tmake.
 

-If your application uses only some of wxWindows libraries, you can
+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 
 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 

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


@@ -472,7 +488,7 @@ and configure before you can type make.
   # makewxmotif
   # Sets permissions (in case we extracted wxMotif from zip files)
   # and makes wxMotif.
   # makewxmotif
   # Sets permissions (in case we extracted wxMotif from zip files)
   # and makes wxMotif.

-  # Call from top-level wxWindows directory.
+  # Call from top-level wxWidgets directory.

   # Note that this uses standard (but commonly-used) configure options;
   # if you're feeling brave, you may wish to compile with threads:
   # if they're not supported by the target platform, they will be disabled
   # Note that this uses standard (but commonly-used) configure options;
   # if you're feeling brave, you may wish to compile with threads:
   # if they're not supported by the target platform, they will be disabled


@@ -484,7 +500,7 @@ and configure before you can type make.
   -------:x-----Cut here-----:x-----
 
   This script will build wxMotif using shared libraries. If you want to build
   -------:x-----Cut here-----:x-----
 
   This script will build wxMotif using shared libraries. If you want to build

-  a static wxWindows library, use --disable-shared.
+  a static wxWidgets library, use --disable-shared.

 
 Troubleshooting
 ---------------
 
 Troubleshooting
 ---------------


@@ -524,7 +540,7 @@ Bug reports
 Please send bug reports with a description of your environment,
 compiler and the error message(s) to the wxwin-developers mailing list at:
 
 Please send bug reports with a description of your environment,
 compiler and the error message(s) to the wxwin-developers mailing list at:
 

-    wx-dev@lists.wxwindows.org
+    wx-dev@lists.wxwidgets.org

 
 Julian Smart, Robert Roebling and Vadim Zeitlin, November 1999.
 
 
 Julian Smart, Robert Roebling and Vadim Zeitlin, November 1999.