don't set score files permissions to 0666, why would this be needed or wanted? (and...

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

diff --git a/docs/motif/install.txt b/docs/motif/install.txt
index 64440415257231a64e4cdd59fdcc2df8b27c8ce8..efadc9ba07bbbc155e51cdd5210cc4e42cec9f27 100644 (file)
--- a/docs/motif/install.txt
+++ b/docs/motif/install.txt
@@ -1,4 +1,4 @@
-wxWindows 2.3 for Motif installation
+wxWidgets 2.8.0 for Motif installation

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


@@ -6,22 +6,23 @@ 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.
   
   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.3.4, gcc 2.95.4, Redhat 6.1
+  example: wxMotif 2.8.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
   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.


@@ -29,11 +30,11 @@ 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 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.


@@ -45,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


@@ -63,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


@@ -73,34 +74,37 @@ 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_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.

 
 

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


@@ -125,15 +129,15 @@ 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 
   
 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 
+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...
 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...


@@ -141,29 +145,23 @@ 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.
 
 You can get the newest version of the Lesstif from the lesstif homepage at:
 
 an alternative, you may also use the free library "lesstif" which implements
 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:
 

-  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
+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
 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 
 
 ./configure --disable-threads
 You can disable thread support by running 
 
 ./configure --disable-threads


@@ -177,45 +175,44 @@ 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.
+to Stefan Neis <Stefan.Neis@t-online.de> and patches to
+the wxWidgets 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),
-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).
+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.

 
 

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

 
 

-Notice you can choose whatever you want, if you don't like OS2X.
+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.

 
 

-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-motif
-as described above.
+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-motif"
+and make and possibly make install as described above.

 
 To verify Lesstif 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.
 
 
 To verify Lesstif 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.
 

-If you have pthreads library installed, it will be autodetected
-and the library will be compiled with thread-support.
-
-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 wxMotif on SGI
 -------------------------
 
 * Building wxMotif on SGI
 -------------------------
 


@@ -234,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
 ---------------------------
 


@@ -273,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).


@@ -285,15 +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.
 

-       --disable-optimise      Do not optimise the code. Can
+       --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
                                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.


@@ -312,22 +327,25 @@ 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_info     Add debug info to object files and
                                executables for use with debuggers
                                such as gdb (or its many frontends).
 
        --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
        --enable-debug_info     Add debug info to object files and
                                executables for use with debuggers
                                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


@@ -338,50 +356,53 @@ 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. Not yet. }
-       
-        --disable-resources     Disables the use of *.wxr type
-                               resources.
-               
+
+       --without-odbc          Disables ODBC code.
+
+       --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-serial        Disables object instance serialisation.
-       
+

        --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"
 the program of its debugging information resulting in a significant
 reduction in size.
 
        --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.
 

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

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


@@ -394,7 +415,7 @@ 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


@@ -407,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
        


@@ -443,8 +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 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.


@@ -461,19 +488,19 @@ 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
   # anyhow
   # -- Julian Smart
   chmod a+x configure config.sub config.guess
   # 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
   # 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-----
 
   This script will build wxMotif using shared libraries. If you want to build
   make
   -------: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
 ---------------


@@ -502,14 +529,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
 -----------