X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3a922bb4bd8dbcb04e31e324648c2912e167e0cd..3214ac5ad1d515d917b8273c2d2af4c4287b7a8b:/docs/motif/install.txt diff --git a/docs/motif/install.txt b/docs/motif/install.txt index 2eada2b3f4..973e659693 100644 --- a/docs/motif/install.txt +++ b/docs/motif/install.txt @@ -1,27 +1,28 @@ -wxWindows 2.3 for Motif installation ------------------------------------- +wxWidgets for Motif installation +-------------------------------- 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 - 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 + When sending bug reports tell us what version of wxWidgets 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.8.1, gcc 2.95.4, Redhat 6.1 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. + wxWidgets-HTML.zip or wxWidgets-PDF.zip. - Make a directory such as ~/wx and unarchive the files into this directory. @@ -29,23 +30,23 @@ 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 - XPM support in wxWindows (recommended). + XPM support in wxWidgets (recommended). -- You now have the option of using the configure-based system, or the simple - makefile system. +- 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 wxwin-developers@wx.dent.med.uni-muenchen.de. + config.log file) to wx-dev@lists.wxwindows.org. + 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 +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 @@ -63,7 +64,7 @@ Afterwards you can continue with > 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 > make uninstall @@ -73,153 +74,147 @@ If you want to remove wxWindows on Unix you can do this: * 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 concurretly. For this end, you have to create a directory for each build -of wxWindows - you may also want to create different versions of wxWindows +them concurrently. For this end, you have to create a directory for each build +of wxWidgets - you may also want to create different versions of wxWidgets 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 +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: -md buildmotif +mkdir buildmotif cd buildmotif ../configure --with-motif make cd .. -md buildgtk +mkdir buildgtk cd buildgtk ../configure --with-gtk make cd .. -md buildgtkd +mkdir buildgtkd cd buildgtkd -../configure --with-gtk --enable-debug_flag +../configure --with-gtk --enable-debug make cd .. -* The most simple errors ------------------------- +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. -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 -g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo +g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo * General ------------------------ +--------- -The Unix variants of wxWindows use GNU configure. If you have problems with your -make use GNU make instead. +The Unix variants of wxWidgets 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 wxWidgets website at - http://wesley.informatik.uni-freiburg.de/~wxxt + 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 -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 ------------------------ +--------------- -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: - http://www.lesstif.org + http://www.lesstif.org/ * 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: - - - RedHat 5.1 - - Debian 2.0 - - Stampede - - DLD 6.0 - - SuSE 6.0 - +---------------------- + +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 +correct glibc 2 support. + You can disable thread support by running -./configure "--disable-threads" +./configure --disable-threads make su 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 -to Andrea Venturoli and patches to -the wxWindows mailing list. +to Stefan Neis 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: +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). -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. - -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=/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. -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 --------------------------- +------------------------- Using the SGI native compilers, it is recommended that you also set CFLAGS and CXXFLAGS before running configure. These @@ -236,11 +231,25 @@ untested). 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 ------------------------------ +--------------------------- Usage: - ./configure options + ./configure [options] If you want to use system's C and C++ compiler, set environment variables CXX and CC as @@ -274,14 +283,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. -Many of the confiugre options have been thoroughly tested -in wxWindows snapshot 6, but not yet all (ODBC not). +Many of the configure options have been thoroughly tested +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 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. @@ -289,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 - socket code to work. + socket code to work. --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 - 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. @@ -316,21 +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-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-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 - 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 @@ -338,57 +353,60 @@ The following options handle the kind of library you want to build. options. * Feature Options -------------------- +----------------- -Many of the confiugre options have been thoroughly tested -in wxWindows snapshot 6, but not yet all (ODBC not). +Many of the configure options have been thoroughly tested +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 -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. - + --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-clipboard Disables Clipboard. - - --disable-serial Disables object instance serialiasation. - + --disable-streams Disables the wxStream classes. - + --disable-file Disables the wxFile class. - + --disable-textfile Disables the wxTextFile class. - + --disable-intl Disables the internationalisation. - + --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. +Please see the output of "./configure --help" for comprehensive list +of all configurable options. + + * 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 @@ -397,20 +415,20 @@ the library by typing: 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 -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 make install -You can remove any traces of wxWindows by typing +You can remove any traces of wxWidgets by typing make uninstall @@ -422,12 +440,12 @@ object-files: 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 -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 @@ -438,16 +456,22 @@ minimal: minimal.o $(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 -to sitch to tmake. +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 -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. @@ -464,68 +488,26 @@ and configure before you can type make. # 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 - ./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 - a static wxWindows library, use --disable-shared. - -COMPILING USING MAKEFILES -========================= - -- Copy the file include/wx/motif/setup0.h to include/wx/motif/setup.h and - edit it if you wish to enable/disable some library features - -- Choose a .env file from src/makeenvs that matches your - environment, and copy it to src/make.env. These are the - settings read by wxWindows for Motif makefiles. - -- Edit src/make.env to change options according to your local - environment. In particular, change WXDIR to where wxWindows is - found on your system, or set the WXWIN environment variable - before compilation, e.g.: - - export WXWIN=/home/jacs/wx2 - - Please feel free to contribute settings files for your environment. - -- Change directory to src/motif and type: - - make -f makefile.unx motif - - This should make the library libwx_motif.a in the lib - directory. Note that this makefile system does not build shared - libraries, only static ones (that is, the wxWindows library will be - linked statically; to see remaining dependencies on shared libraries, - type e.g. ldd minimal_motif). - -- Make a sample, such as the minimal sample: - - cd samples/minimal - make -f makefile.unx motif - - and run the resulting minimal_motif binary. + a static wxWidgets library, use --disable-shared. Troubleshooting --------------- -- If you have trouble compiling the file y_tab.c, or have strange - linking errors, check whether you're using a C or C++ compiler for this file. - You should specify a C compiler in the CCLEX variable in src/make.env. - You could also try using bison and flex instead of yacc and - lex. - -- 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 @@ -539,15 +521,6 @@ Troubleshooting possible temporary workaround (comment out the final XtDestroyWidget from ~wxWindow in window.cpp). -- If you use flex and bison instead of yacc and lex, you may need - to change the relevant part of src/motif/makefile.unx to read: - - ../common/y_tab.c: ../common/parser.y - $(YACC) ../common/parser.y - mv ../common/parser.tab.c ../common/y_tab.c - - (the 'mv' command needs to be changed) - - Some compilers, such as Sun C++, may give a lot of warnings about virtual functions being hidden. Please ignore these, it's correct C++ syntax. If you find any incorrect instances, though, such as a @@ -556,42 +529,10 @@ Troubleshooting 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). - -- Some classes can be switched off in include/wx/motif/setup.h, - if you are having trouble with a particular file. However, - I'd prefer you to fix the problem and send the fix to me :-) or at - least let me know about it. - -- Thread support is switched off by default in setup.h (wxUSE_THREADS) - because standard Unices often do not have the necessary thread library - installed. Please see ../docs/gtk/install.txt for more details on this. - The systems for which thread support is known to work are Linux with libc6 - (a.k.a. glibc2), Solaris 2.5 and 2.6 (provided that X libraries are thread - safe) and, to some extent, FreeBSD 2.8 and 3.1 (any feedback on thread - support under FreeBSD as well as the systems not mentioned here would be - appreciated). - -- If you run into problems with a missing X11/Xpm.h header, you - need to install the XPM package. It can be obtained from: - - ftp://ftp.x.org/contrib/libraries/xpm-3.4k.tar.gz - http://sunfreeware.com - - You may need to modify make.env to add -I and -L options pointing to where Xpm - is installed and possibly change bitmap.cpp to - include instead of - - Alternatively, edit include/wx/motif/setup.h, set wxUSE_XPM - to 0, and recompile. You will not be able to load any XPMs, - though (currently the only supported colour bitmap format). +- 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 ----------- @@ -599,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: - wxwin-developers@wx.dent.med.uni-muenchen.de + wx-dev@lists.wxwindows.org Julian Smart, Robert Roebling and Vadim Zeitlin, November 1999.