fixed syntax errors

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

diff --git a/docs/motif/install.txt b/docs/motif/install.txt
index c0c3157acb0bcc9391778f2207ee3fc6e80589b3..984729779a86bb69bc72fbe4afb53a2bf2f22969 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.3, gcc 2.95.4, Redhat 6.1
+  example: wxMotif 2.5.1, 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.


@@ -78,26 +79,26 @@ 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
 and test them concurrently. Most typically, this would be a version configured 
 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 

-with --enable-debug_flag and one without. Note, that only one build can
+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:
 
 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 ..
 


@@ -133,7 +134,7 @@ If you have general problems with installation, see the wxWindows website at
   http://www.wxwindows.org/
   
 for newest information. If you still don't have any success, please send a bug 
   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 
+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...


@@ -147,7 +148,7 @@ 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
 ----------------------


@@ -155,15 +156,9 @@ You can get the newest version of the Lesstif from the lesstif homepage at:
 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
 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
- - 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 +172,45 @@ 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
+to Stefan Neis <Stefan.Neis@t-online.de> and patches to

 the wxWindows mailing list.
 
 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),
-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:
+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),
+GNU shell utilites (1.12), m4 (1.4), sed (2.05), grep (2.0), Awk (3.0.3),
+GNU Make (3.75).

 
 

-SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__
-SET CFLAGS=-Zmtd -D__ST_MT_ERRNO__
-SET OSTYPE=OS2X              
-SET COMSPEC=sh
+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.

 
 

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

 
 

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


@@ -285,15 +280,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 wxWindows as single library instead
+                            of as several smaller libraries (which is
+                            the default since wxWindows 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.


@@ -322,6 +321,9 @@ The following options handle the kind of library you want to build.
        --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_info     Add debug info to object files and
                                executables for use with debuggers
                                such as gdb (or its many frontends).


@@ -350,11 +352,12 @@ 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.
+   
+    --without-libtiff       Disables TIFF image format code.
+ 
+    --without-expat         Disable XML classes based on Expat parser.

        
        

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


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

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

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


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

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

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


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


@@ -443,6 +448,12 @@ 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
+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
 GNU autoconf version 2.14 and add an entry to your Makefile.in
 2) The other way creates a project within the source code 
 directories of wxWindows. For this endeavour, you'll need
 GNU autoconf version 2.14 and add an entry to your Makefile.in


@@ -468,7 +479,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-----
 


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