Move [GS]etDefaultItem up to wxWindow
[wxWidgets.git] / docs / motif / install.txt
1 wxWindows 2.3 for Motif installation
2 ------------------------------------
3
4 IMPORTANT NOTE:
5
6 If you experience problems installing, please re-read these
7 instructions and other related files (todo.txt, bugs.txt and
8 osname.txt for your platform if it exists) carefully before
9 mailing wxwin-users or the author. Preferably, try to fix the
10 problem first and then send a patch to the author.
11
12 When sending bug reports tell us what version of wxWindows you are
13 using (including the beta) and what compiler on what system. One
14 example: wxMotif 2.3.0, egcs 1.1.1, Redhat 5.0
15
16 First steps
17 -----------
18
19 - Prerequisites: Motif 1.2 or above, or Lesstif
20 (not yet tested). Motif 2.0 and above may also be suitable.
21
22 - Download wxMotif-x.y.z.tgz, where x.y.z is the version number.
23 Download documentation in a preferred format, such as
24 wxWindows-HTML.zip or wxWindows-PDF.zip.
25
26 - Make a directory such as ~/wx and unarchive the files into this
27 directory.
28
29 - It is recommended that you install bison and flex; using yacc
30 and lex may require tweaking of the makefiles. You also need
31 libXpm (see comments in the Notes section below) if you want to have
32 XPM support in wxWindows (recommended).
33
34 - You now have the option of using the configure-based system, or the simple
35 makefile system.
36
37 Using configure is the recommended way to build the library. If it doesn't
38 work for you for whatever reason, please report it (together with detailed
39 information about your platform and the (relevant part of) contents of
40 config.log file) to wxwin-developers@wx.dent.med.uni-muenchen.de.
41
42 COMPILING USING CONFIGURE
43 =========================
44
45 * The most simple case
46 -----------------------
47
48 If you compile wxWindows on Linux for the first time and don't like to read
49 install instructions just do (in the base dir):
50
51 > ./configure --with-motif
52 > make
53 > su <type root password>
54 > make install
55 > ldconfig
56 > exit
57
58 Afterwards you can continue with
59
60 > make
61 > su <type root password>
62 > make install
63 > ldconfig
64 > exit
65
66 If you want to remove wxWindows on Unix you can do this:
67
68 > su <type root password>
69 > make uninstall
70 > ldconfig
71 > exit
72
73 * The expert case
74 -----------------
75
76 If you want to do some more serious cross-platform programming with wxWindows,
77 such as for GTK and Motif, you can now build two complete libraries and use
78 them concurretly. For this end, you have to create a directory for each build
79 of wxWindows - you may also want to create different versions of wxWindows
80 and test them concurrently. Most typically, this would be a version configured
81 with --enable-debug_flag and one without. Note, that only one build can currently
82 be installed, so you'd have to use local version of the library for that purpose.
83 For building three versions (one GTK, one Motif and a debug version of the GTK
84 source) you'd do this:
85
86 md buildmotif
87 cd buildmotif
88 ../configure --with-motif
89 make
90 cd ..
91
92 md buildgtk
93 cd buildgtk
94 ../configure --with-gtk
95 make
96 cd ..
97
98 md buildgtkd
99 cd buildgtkd
100 ../configure --with-gtk --enable-debug_flag
101 make
102 cd ..
103
104 * The most simple errors
105 ------------------------
106
107 You get errors during compilation: The reason is that you probably have a broken
108 compiler, which includes almost everything that is called gcc. If you use gcc 2.8
109 you have to disable optimsation as the compiler will give up with an internal
110 compiler error.
111
112 If there is just any way for you to use egcs, use egcs. We cannot fix gcc.
113
114 You get immediate segfault when starting any sample or application: This is either
115 due to having compiled the library with different flags or options than your program -
116 typically you might have the __WXDEBUG__ option set for the library but not for your
117 program - or due to using a broken compiler (and its optimisation) such as GCC 2.8.
118
119 * The most simple program
120 -------------------------
121
122 Now create your super-application myfoo.app and compile anywhere with
123
124 g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo
125
126 * General
127 -----------------------
128
129 The Unix variants of wxWindows use GNU configure. If you have problems with your
130 make use GNU make instead.
131
132 If you have general problems with installation, read my homepage at
133
134 http://wesley.informatik.uni-freiburg.de/~wxxt
135
136 for newest information. If you still don't have any success, please send a bug
137 report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF
138 YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF GTK, WXGTK, WHAT DISTRIBUTION
139 YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
140
141 * GUI libraries
142 -----------------------
143
144 wxWindows/Motif requires the Motif library to be installed on your system. As
145 an alternative, you may also use the free library "lesstif" which implements
146 most of the Motif API without the licence restrictions of Motif.
147
148 You can get the newest version of the Lesstif from the lesstif homepage at:
149
150 http://www.lesstif.org
151
152 * Additional libraries
153 -----------------------
154
155 wxWindows/Motif requires a thread library and X libraries known to work with threads.
156 This is the case on all commercial Unix-Variants and all Linux-Versions that are
157 based on glibc 2 except RedHat 5.0 which is broken in many aspects. As of writing
158 this, these Linux distributions have correct glibc 2 support:
159
160 - RedHat 5.1
161 - Debian 2.0
162 - Stampede
163 - DLD 6.0
164 - SuSE 6.0
165
166 You can disable thread support by running
167
168 ./configure "--disable-threads"
169 make
170 su <type root password>
171 make install
172 ldconfig
173 exit
174
175 NB: DO NOT COMPILE WXGTK WITH GCC AND THREADS, SINCE ALL PROGRAMS WILL
176 CRASH UPON START-UP! Just always use egcs and be happy.
177
178 * Building wxGTK on OS/2
179 --------------------------
180
181 Please send comments and question about the OS/2 installation
182 to Andrea Venturoli <a.ventu@flashnet.it> and patches to
183 the wxWindows mailing list.
184
185 You'll need OS/2 Warp (4.00FP#6), X-Free86/2 (3.3.3 or newer),
186 Lesstif (0.89.1 or newer), emx (0.9d fix 1), flex (2.5.4),
187 yacc (1.8), unix like shell, e.g. korn shell (5.2.13),
188 Autoconf (2.13), GNU file utilities (3.6),
189 GNU text utilities (1.3), GNU shell utilites (1.12), m4 (1.4),
190 sed (2.05), grep (2.0), Awk (3.0.3), GNU Make (3.76.1).
191
192 Open an OS/2 prompt and switch to the directory above.
193 First set some global environment variables we need:
194
195 SET CXXFLAGS=-Zmtd -D__ST_MT_ERRNO__
196 SET CFLAGS=-Zmtd -D__ST_MT_ERRNO__
197 SET OSTYPE=OS2X
198 SET COMSPEC=sh
199
200 Notice you can choose whatever you want, if you don't like OS2X.
201
202 Now, run autoconf in the main directory and in the samples, demos
203 and utils subdirectory. This will generate the OS/2 specific
204 versions of the configure scripts. Now run
205 configure --with-motif
206 as described above.
207
208 To verify Lesstif installation, configure will try to compile a
209 sample program that requires X headers/libraries to be either
210 available via C_INCLUDE_PATH and LIBRARY_PATH or you need to
211 explicitly set CFLAGS prior to running configure.
212
213 If you have pthreads library installed, it will be autodetected
214 and the library will be compiled with thread-support.
215
216 Note that configure assumes your flex will generate files named
217 "lexyy.c", not "lex.yy.c". If you have a version which does
218 generate "lex.yy.c", you need to manually change the generated
219 makefile.
220
221 * Building wxMotif on SGI
222 --------------------------
223
224 Using the SGI native compilers, it is recommended that you
225 also set CFLAGS and CXXFLAGS before running configure. These
226 should be set to :
227
228 CFLAGS="-mips3 -n32"
229 CXXFLAGS="-mips3 -n32"
230
231 This is essential if you want to use the resultant binaries
232 on any other machine than the one it was compiled on. If you
233 have a 64bit machine (Octane) you should also do this to ensure
234 you don't accidently build the libraries as 64bit (which is
235 untested).
236
237 The SGI native compiler support has only been tested on Irix 6.5.
238
239 * Create your configuration
240 -----------------------------
241
242 Usage:
243 ./configure options
244
245 If you want to use system's C and C++ compiler,
246 set environment variables CXX and CC as
247
248 % setenv CC cc
249 % setenv CXX CC
250 % ./configure options
251
252 to see all the options please use:
253
254 ./configure --help
255
256 The basic philosophy is that if you want to use different
257 configurations, like a debug and a release version,
258 or use the same source tree on different systems,
259 you have only to change the environment variable OSTYPE.
260 (Sadly this variable is not set by default on some systems
261 in some shells - on SGI's for example). So you will have to
262 set it there. This variable HAS to be set before starting
263 configure, so that it knows which system it tries to
264 configure for.
265
266 Configure will complain if the system variable OSTYPE has
267 not been defined. And Make in some circumstances as well...
268
269
270 * General options
271 -------------------
272
273 Given below are the commands to change the default behaviour,
274 i.e. if it says "--disable-threads" it means that threads
275 are enabled by default.
276
277 Many of the confiugre options have been thoroughly tested
278 in wxWindows snapshot 6, but not yet all (ODBC not).
279
280 You have to add --with-motif on platforms, where Motif is
281 not the default (on Linux, configure will deafult to GTK).
282
283 --without-gtk Don't use the GIMP ToolKit (GTK)
284
285 --with-motif Use either Motif or Lesstif
286 Configure will look for both.
287
288 The following options handle the kind of library you want to build.
289
290 --disable-threads Compile without thread support. Threads
291 support is also required for the
292 socket code to work.
293
294 --disable-shared Do not create shared libraries.
295
296 --disable-optimise Do not optimise the code. Can
297 sometimes be useful for debugging
298 and is required on some architectures
299 such as Sun with gcc 2.8.X which
300 would otherwise produce segvs.
301
302 --enable-profile Add profiling info to the object
303 files. Currently broken, I think.
304
305 --enable-no_rtti Enable compilation without creation of
306 C++ RTTI information in object files.
307 This will speed-up compilation and reduce
308 binary size.
309
310 --enable-no_exceptions Enable compilation without creation of
311 C++ exception information in object files.
312 This will speed-up compilation and reduce
313 binary size. Also fewer crashes during the
314 actual compilation...
315
316 --enable-no_deps Enable compilation without creation of
317 dependency information.
318
319 --enable-permissive Enable compilation without creation of
320 giving erros as soon as you compile with
321 Solaris ANSI-defying headers...
322
323 --enable-mem_tracing Add built-in memory tracing.
324
325 --enable-dmalloc Use the dmalloc memory debugger.
326 Read more at www.letters.com/dmalloc/
327
328 --enable-debug_info Add debug info to object files and
329 executables for use with debuggers
330 such as gdb (or its many frontends).
331
332 --enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when
333 compiling. This enable wxWindows' very
334 useful internal debugging tricks (such
335 as automatically reporting illegal calls)
336 to work. Note that program and library
337 must be compiled with the same debug
338 options.
339
340 * Feature Options
341 -------------------
342
343 Many of the confiugre options have been thoroughly tested
344 in wxWindows snapshot 6, but not yet all (ODBC not).
345
346 When producing an executable that is linked statically with wxGTK
347 you'll be surprised at its immense size. This can sometimes be
348 drastically reduced by removing features from wxWindows that
349 are not used in your program. The most relevant such features
350 are
351
352 --without-libpng Disables PNG image format code.
353
354 --without-libjpeg Disables JPEG image format code.
355
356 { --without-odbc Disables ODBC code. Not yet. }
357
358 --disable-resources Disables the use of *.wxr type
359 resources.
360
361 --disable-threads Disables threads. Will also
362 disable sockets.
363
364 --disable-sockets Disables sockets.
365
366 --disable-dnd Disables Drag'n'Drop.
367
368 --disable-clipboard Disables Clipboard.
369
370 --disable-serial Disables object instance serialiasation.
371
372 --disable-streams Disables the wxStream classes.
373
374 --disable-file Disables the wxFile class.
375
376 --disable-textfile Disables the wxTextFile class.
377
378 --disable-intl Disables the internationalisation.
379
380 --disable-validators Disables validators.
381
382 --disable-accel Disables accel.
383
384 Apart from disabling certain features you can very often "strip"
385 the program of its debugging information resulting in a significant
386 reduction in size.
387
388 * Compiling
389 -------------
390
391 The following must be done in the base directory (e.g. ~/wxGTK
392 or ~/wxWin or whatever)
393
394 Now the makefiles are created (by configure) and you can compile
395 the library by typing:
396
397 make
398
399 make yourself some coffee, as it will take some time. On an old
400 386SX possibly two weeks. During compilation, you'll get a few
401 warning messages depending in your compiler.
402
403 If you want to be more selective, you can change into a specific
404 directiry and type "make" there.
405
406 Then you may install the library and it's header files under
407 /usr/local/include/wx and /usr/local/lib respectively. You
408 have to log in as root (i.e. run "su" and enter the root
409 password) and type
410
411 make install
412
413 You can remove any traces of wxWindows by typing
414
415 make uninstall
416
417 If you want to save disk space by removing unnecessary
418 object-files:
419
420 make clean
421
422 in the various directories will do the work for you.
423
424 * Creating a new Project
425 --------------------------
426
427 1) The first way uses the installed libraries and header files
428 automatically using wx-config
429
430 g++ myfoo.cpp `wx-config --libs` `wx-config --cflags` -o myfoo
431
432 Using this way, a make file for the minimal sample would look
433 like this
434
435 CXX = g++
436
437 minimal: minimal.o
438 $(CXX) -o minimal minimal.o `wx-config --libs`
439
440 minimal.o: minimal.cpp mondrian.xpm
441 $(CXX) `wx-config --cflags` -c minimal.cpp -o minimal.o
442
443 clean:
444 rm -f *.o minimal
445
446 This is certain to become the standard way unless we decide
447 to sitch to tmake.
448
449 2) The other way creates a project within the source code
450 directories of wxWindows. For this endeavour, you'll need
451 GNU autoconf version 2.14 and add an entry to your Makefile.in
452 to the bottom of the configure.in script and run autoconf
453 and configure before you can type make.
454
455 * Further notes by Julian Smart
456 ---------------------------------
457
458 - You may find the following script useful for compiling wxMotif,
459 especially if installing from zips (which don't preserve file
460 permissions). Make this script executable with the command
461 chmod a+x makewxmotif.
462
463 -------:x-----Cut here-----:x-----
464 # makewxmotif
465 # Sets permissions (in case we extracted wxMotif from zip files)
466 # and makes wxMotif.
467 # Call from top-level wxWindows directory.
468 # Note that this uses standard (but commonly-used) configure options;
469 # if you're feeling brave, you may wish to compile with threads:
470 # if they're not supported by the target platform, they will be disabled
471 # anyhow
472 # -- Julian Smart
473 chmod a+x configure config.sub config.guess
474 ./configure --with-shared --with-motif --without-gtk --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc
475 make
476 -------:x-----Cut here-----:x-----
477
478 This script will build wxMotif using shared libraries. If you want to build
479 a static wxWindows library, use --disable-shared.
480
481 COMPILING USING MAKEFILES
482 =========================
483
484 - Copy the file include/wx/motif/setup0.h to include/wx/motif/setup.h and
485 edit it if you wish to enable/disable some library features
486
487 - Choose a .env file from src/makeenvs that matches your
488 environment, and copy it to src/make.env. These are the
489 settings read by wxWindows for Motif makefiles.
490
491 - Edit src/make.env to change options according to your local
492 environment. In particular, change WXDIR to where wxWindows is
493 found on your system, or set the WXWIN environment variable
494 before compilation, e.g.:
495
496 export WXWIN=/home/jacs/wx2
497
498 Please feel free to contribute settings files for your environment.
499
500 - Change directory to src/motif and type:
501
502 make -f makefile.unx motif
503
504 This should make the library libwx_motif.a in the lib
505 directory. Note that this makefile system does not build shared
506 libraries, only static ones (that is, the wxWindows library will be
507 linked statically; to see remaining dependencies on shared libraries,
508 type e.g. ldd minimal_motif).
509
510 - Make a sample, such as the minimal sample:
511
512 cd samples/minimal
513 make -f makefile.unx motif
514
515 and run the resulting minimal_motif binary.
516
517 Troubleshooting
518 ---------------
519
520 - If you have trouble compiling the file y_tab.c, or have strange
521 linking errors, check whether you're using a C or C++ compiler for this file.
522 You should specify a C compiler in the CCLEX variable in src/make.env.
523 You could also try using bison and flex instead of yacc and
524 lex.
525
526 - Solaris compilation with gcc: if the compiler has problems with the variable argument
527 functions, try putting the gcc fixinclude file paths early in the include
528 path.
529
530 - If you operator-related compile errors or strange memory problems
531 (for example in deletion of string arrays), set wxUSE_GLOBAL_MEMORY_OPERATORS
532 and wxUSE_MEMORY_TRACING to 0 in setup.h, and recompile.
533
534 - If you get an internal compiler error in gcc, turn off optimisations.
535
536 - Problems with XtDestroyWidget crashing in ~wxWindow have been
537 reported on SGI IRIX 6.4. This has not yet been resolved, so
538 any advice here would be very welcome. See bugs.txt for a
539 possible temporary workaround (comment out the final
540 XtDestroyWidget from ~wxWindow in window.cpp).
541
542 - If you use flex and bison instead of yacc and lex, you may need
543 to change the relevant part of src/motif/makefile.unx to read:
544
545 ../common/y_tab.c: ../common/parser.y
546 $(YACC) ../common/parser.y
547 mv ../common/parser.tab.c ../common/y_tab.c
548
549 (the 'mv' command needs to be changed)
550
551 - Some compilers, such as Sun C++, may give a lot of warnings about
552 virtual functions being hidden. Please ignore these, it's correct C++ syntax.
553 If you find any incorrect instances, though, such as a
554 missing 'const' in an overridden function, please let us know.
555
556 Other Notes
557 -----------
558
559 - Debugging mode is switched on by default in the makefiles, but using
560 configure will create a release build of the library by default: it's
561 recommended to use --with-debug_info and --with-debug_flag configure
562 switches while developing your application. To compile in non-debug
563 mode, remove the -D__WXDEBUG__ switch in make.env (or if using the
564 configure system, change --with-debug_flag to --without_debug_flag
565 and --with-debug_info to --without-debug_info in the makewxmotif
566 script).
567
568 - Some classes can be switched off in include/wx/motif/setup.h,
569 if you are having trouble with a particular file. However,
570 I'd prefer you to fix the problem and send the fix to me :-) or at
571 least let me know about it.
572
573 - Thread support is switched off by default in setup.h (wxUSE_THREADS)
574 because standard Unices often do not have the necessary thread library
575 installed. Please see ../docs/gtk/install.txt for more details on this.
576 The systems for which thread support is known to work are Linux with libc6
577 (a.k.a. glibc2), Solaris 2.5 and 2.6 (provided that X libraries are thread
578 safe) and, to some extent, FreeBSD 2.8 and 3.1 (any feedback on thread
579 support under FreeBSD as well as the systems not mentioned here would be
580 appreciated).
581
582 - If you run into problems with a missing X11/Xpm.h header, you
583 need to install the XPM package. It can be obtained from:
584
585 ftp://ftp.x.org/contrib/libraries/xpm-3.4k.tar.gz
586 http://sunfreeware.com
587
588 You may need to modify make.env to add -I and -L options pointing to where Xpm
589 is installed and possibly change bitmap.cpp to
590 include <xpm.h> instead of <X11/xpm.h>
591
592 Alternatively, edit include/wx/motif/setup.h, set wxUSE_XPM
593 to 0, and recompile. You will not be able to load any XPMs,
594 though (currently the only supported colour bitmap format).
595
596 Bug reports
597 -----------
598
599 Please send bug reports with a description of your environment,
600 compiler and the error message(s) to the wxwin-developers mailing list at:
601
602 wxwin-developers@wx.dent.med.uni-muenchen.de
603
604 Julian Smart, Robert Roebling and Vadim Zeitlin, November 1999.
605