docs/gtk/install.txt

   1 wxWidgets 2.6 for GTK+ 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 wxWidgets you are
  13   using (including the beta) and what compiler on what system. One
  14   example: wxGTK 2.6.3, gcc 3.4.5, Fedora Core 4
  15
  16 * The simplest case
  17 -------------------
  18
  19 If you compile wxWidgets on Linux for the first time and don't like to read
  20 install instructions just do (in the base dir):
  21
  22 > mkdir buildgtk
  23 > cd buildgtk
  24 > ../configure --with-gtk
  25 > make
  26 > su <type root password>
  27 > make install
  28 > ldconfig
  29 [if you get "ldconfig: command not found", try using "/sbin/ldconfig"]
  30
  31 If you don't do the 'make install' part, you can still use the libraries from
  32 the buildgtk directory, but they may not be available to other users.
  33
  34 If you want to remove wxWidgets on Unix you can do this:
  35
  36 > su <type root password>
  37 > make uninstall
  38 > ldconfig
  39
  40 Note that by default, GTK+ 2.X is used. GTK+ 1.2 can be specified
  41 with --with-gtk=1.
  42
  43 * The expert case
  44 -----------------
  45
  46 If you want to do some more serious cross-platform programming with wxWidgets,
  47 such as for GTK+ and Motif, you can now build two complete libraries and use
  48 them concurrently. To do this, create a separate directory for each build
  49 of wxWidgets - you may also want to create different versions of wxWidgets
  50 and test them concurrently. Most typically, this would be a version configured
  51 with --enable-debug and one without. Note, that only one build can
  52 currently be installed with 'make install', so you'd have to use local version of
  53 the library for that purpose.
  54
  55 For building three versions (one GTK+, one Motif and a debug version of the GTK
  56 source) you'd do this:
  57
  58 md buildmotif
  59 cd buildmotif
  60 ../configure --with-motif
  61 make
  62 cd ..
  63
  64 md buildgtk
  65 cd buildgtk
  66 ../configure --with-gtk
  67 make
  68 cd ..
  69
  70 md buildgtkd
  71 cd buildgtkd
  72 ../configure --with-gtk --enable-debug
  73 make
  74 cd ..
  75
  76 * The simplest errors
  77 ---------------------
  78
  79 For any configure errors: please look at config.log file which was generated
  80 during configure run, it usually contains some useful information.
  81
  82 configure reports, that you don't have GTK+ 1.2 installed although you are
  83 very sure you have. Well, you have installed it, but you also have another
  84 version of the GTK+ installed, which you may need to remove including other
  85 versions of glib (and its headers). Or maybe you installed it in non default
  86 location and configure can't find it there, so please check that your PATH
  87 variable includes the path to the correct gtk-config. Also check that your
  88 LD_LIBRARY_PATH or equivalent variable contains the path to GTK+ libraries if
  89 they were installed in a non default location.
  90
  91 You get errors from make: please use GNU make instead of the native make
  92 program. Currently wxWidgets can be built only with GNU make, BSD make and
  93 Solaris make. Other versions might work or not (any which don't have VPATH
  94 support definitely won't).
  95
  96 You get errors during compilation: The reason is that you probably have a
  97 broken compiler.  GCC 2.8 and earlier versions and egcs are likely to cause
  98 problems due to incomplete support for C++ and optimisation bugs.  Best to use
  99 GCC 2.95 or later.
 100
 101 You get immediate segfault when starting any sample or application: This is
 102 either due to having compiled the library with different flags or options than
 103 your program - typically you might have the __WXDEBUG__ option set for the
 104 library but not for your program - or due to using a compiler with optimisation
 105 bugs.
 106
 107 Linker complains about missing PROIO_yy_flex_alloc and similar symbols: you
 108 probably have an old version of flex, 2.5.4 is recommended.
 109
 110 * The simplest program
 111 ----------------------
 112
 113 Now create your super-application myfoo.cpp and compile anywhere with
 114
 115 g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
 116
 117 * GUI libraries
 118 ---------------
 119
 120 wxWidgets/GTK+ requires the GTK+ library to be installed on your system. It has
 121 to be a stable version, preferably GTK+ 2.x.y, where x is an even number.
 122 GTK+ version 1.2 is highly discouraged, but if you decide to still use it,
 123 please use version 1.2.10 (at least 1.2.3 is required, 1.2.7 is strongly recommended).
 124
 125 You can get the newest version of the GTK+ from the GTK+ homepage at:
 126
 127   http://www.gtk.org
 128
 129 We also mirror GTK+ at my ftp site. You'll find information about downloading
 130 at my homepage.
 131
 132 * Additional libraries
 133 ----------------------
 134
 135 wxWidgets/Gtk requires a thread library and X libraries known to work with
 136 threads.  This is the case on all commercial Unix-Variants and all
 137 Linux-Versions that are based on glibc 2 except RedHat 5.0 which is broken in
 138 many aspects. As of writing this, virtually all Linux distributions have
 139 correct glibc 2 support.
 140
 141 You can disable thread support by running
 142
 143 ./configure --disable-threads
 144 make
 145 su <type root password>
 146 make install
 147 ldconfig
 148 exit
 149
 150 * Building wxGTK on OS/2
 151 ------------------------
 152
 153 Please send comments and question about the OS/2 installation
 154 to Stefan Neis <Stefan.Neis@t-online.de> and patches to
 155 the wxWidgets mailing list.
 156
 157 In the following list, the version numbers indicate the configuration that
 158 was actually used by myself, newer version should cause no problems and
 159 even older ones are expected to work most of the time.
 160
 161 You'll need OS/2 Warp (4.51) or eCS(1.0), X-Free86/2 (3.3.6 or newer),
 162 GTK+ (1.2.5 or newer), emx (0.9d fix 4), flex (2.5.4), yacc (1.8) or
 163 bison (1.25), a Unix like shell (pdksh-5.2.14 or ash), Autoconf (2.57),
 164 GNU file utilities (3.13), GNU text utilities (1.19),
 165 GNU shell utilites (1.12), m4 (1.4), sed (2.05), grep (2.0), Awk (3.0.3),
 166 GNU Make (3.75).
 167
 168 Preferably, you should have Posix/2 installed and C(PLUS)_INCLUDE_PATH and
 169 LIBRARY_PATH set up accordingly, however, wxGTK will even work without it.
 170 Presence of Posix/2 will be auto-detected.
 171
 172 Open an OS/2 prompt and switch to the directory above.
 173 Set MAKESHELL (and depending on your installation also INSTALL, for me
 174 it tends to try to use the system's tcpip\pcomos\install.exe which causes
 175 problems...) to a Unix like shell, e.g.
 176 SET MAKESHELL=ash
 177
 178 Be warned that depending on the precise version of your make, the
 179 variable that needs to be set might be MAKE_SHELL instead of MAKESHELL.
 180 If you have a really deficient version of GNU make, it might even be
 181 necessary to set SHELL or even COMSPEC to a unix like shell as well.
 182
 183 Notice that the delivered configure scripts are fully OS/2 aware, so you
 184 can simply run
 185     ash -c "configure --with-gtk"
 186 and make and possibly make install as described above.
 187
 188 * Building wxGTK on SGI
 189 -----------------------
 190
 191 Using the SGI native compilers, it is recommended that you
 192 also set CFLAGS and CXXFLAGS before running configure. These
 193 should be set to :
 194
 195 CFLAGS="-mips3 -n32"
 196 CXXFLAGS="-mips3 -n32"
 197
 198 This is essential if you want to use the resultant binaries
 199 on any other machine than the one it was compiled on. If you
 200 have a 64bit machine (Octane) you should also do this to ensure
 201 you don't accidently build the libraries as 64bit (which is
 202 untested).
 203
 204 The SGI native compiler support has only been tested on Irix 6.5.
 205
 206 * Create your configuration
 207 ---------------------------
 208
 209 Usage:
 210     ./configure options
 211
 212 If you want to use system's C and C++ compiler,
 213 set environment variables CC and CCC as
 214
 215     % setenv CC cc
 216     % setenv CXX CC
 217     % ./configure [options]
 218
 219 to see all the options please use:
 220
 221     ./configure --help
 222
 223 It is recommended to build wxWidgets in another directory (maybe a
 224 subdirectory of your wxWidgets installation) as this allows you to
 225 have multiple configurations (for example, debug and release or GTK
 226 and Motif) simultaneously.
 227
 228
 229 * General options
 230 -----------------
 231
 232 Given below are the commands to change the default behaviour,
 233 i.e. if it says "--disable-threads" it means that threads
 234 are enabled by default.
 235
 236 Normally, you won't have to choose a toolkit, because when
 237 you download wxGTK, it will default to --with-gtk etc. But
 238 if you use all of our CVS repository you have to choose a
 239 toolkit. You must do this by running configure with either of:
 240
 241     --with-gtk=2            Use the GTK+ 2.0. Default.
 242     --with-gtk=1            Use the GTK+ 1.2.
 243     --with-motif            Use either Motif or Lesstif
 244                             Configure will look for both.
 245
 246 The following options handle the kind of library you want to build.
 247
 248     --disable-threads       Compile without thread support.
 249
 250     --disable-shared        Do not create shared libraries, but
 251                             build static libraries instead.
 252
 253     --enable-monolithic     Build wxWidgets as single library instead
 254                             of as several smaller libraries (which is
 255                             the default since wxWidgets 2.5.0).
 256
 257     --disable-optimise      Do not optimise the code. Can
 258                             sometimes be useful for debugging
 259                             and is required on some architectures
 260                             such as Sun with gcc 2.8.X which
 261                             would otherwise produce segvs.
 262
 263     --enable-unicode        Enable Unicode support.
 264
 265     --enable-profile        Add profiling info to the object
 266                             files. Currently broken, I think.
 267
 268     --enable-no_rtti        Enable compilation without creation of
 269                             C++ RTTI information in object files.
 270                             This will speed-up compilation and reduce
 271                             binary size.
 272
 273     --enable-no_exceptions  Enable compilation without creation of
 274                             C++ exception information in object files.
 275                             This will speed-up compilation and reduce
 276                             binary size. Also fewer crashes during the
 277                             actual compilation...
 278
 279     --enable-no_deps        Enable compilation without creation of
 280                             dependency information.
 281
 282     --enable-permissive     Enable compilation without checking for strict
 283                             ANSI conformance.  Useful to prevent the build
 284                             dying with errors as soon as you compile with
 285                             Solaris' ANSI-defying headers.
 286
 287     --enable-mem_tracing    Add built-in memory tracing.
 288
 289     --enable-dmalloc        Use the dmalloc memory debugger.
 290                             Read more at www.letters.com/dmalloc/
 291
 292     --enable-debug_info     Add debug info to object files and
 293                             executables for use with debuggers
 294                             such as gdb (or its many frontends).
 295
 296     --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
 297                             compiling. This enable wxWidgets' very
 298                             useful internal debugging tricks (such
 299                             as automatically reporting illegal calls)
 300                             to work. Note that program and library
 301                             must be compiled with the same debug
 302                             options.
 303
 304     --enable-debug          Same as --enable-debug_info and
 305                             --enable-debug_flag together. Unless you have
 306                             some very specific needs, you should use this
 307                             option instead of --enable-debug_info/flag ones
 308                             separately.
 309
 310 * Feature Options
 311 -----------------
 312
 313 When producing an executable that is linked statically with wxGTK
 314 you'll be surprised at its immense size. This can sometimes be
 315 drastically reduced by removing features from wxWidgets that
 316 are not used in your program. The most relevant such features
 317 are
 318
 319     --with-odbc             Enables ODBC code. This is disabled
 320                             by default because iODBC is under the
 321                             L-GPL license which is less liberal than
 322                             wxWidgets license.
 323
 324     --without-libpng        Disables PNG image format code.
 325
 326     --without-libjpeg       Disables JPEG image format code.
 327
 328     --without-libtiff       Disables TIFF image format code.
 329
 330     --without-expat         Disable XML classes based on Expat parser.
 331
 332     --disable-pnm           Disables PNM image format code.
 333
 334     --disable-gif           Disables GIF image format code.
 335
 336     --disable-pcx           Disables PCX image format code.
 337
 338     --disable-iff           Disables IFF image format code.
 339
 340     --disable-resources     Disables the use of *.wxr type resources.
 341
 342     --disable-threads       Disables threads. Will also disable sockets.
 343
 344     --disable-sockets       Disables sockets.
 345
 346     --disable-dnd           Disables Drag'n'Drop.
 347
 348     --disable-clipboard     Disables Clipboard.
 349
 350     --disable-serial        Disables object instance serialisation.
 351
 352     --disable-streams       Disables the wxStream classes.
 353
 354     --disable-file          Disables the wxFile class.
 355
 356     --disable-textfile      Disables the wxTextFile class.
 357
 358     --disable-intl          Disables the internationalisation.
 359
 360     --disable-validators    Disables validators.
 361
 362     --disable-accel         Disables accelerators support.
 363
 364 Apart from disabling certain features you can very often "strip"
 365 the program of its debugging information resulting in a significant
 366 reduction in size.
 367
 368 Please see the output of "./configure --help" for comprehensive list
 369 of all configurable options.
 370
 371
 372 * Compiling
 373 -----------
 374
 375 The following must be done in the base directory (e.g. ~/wxGTK
 376 or ~/wxWin or whatever)
 377
 378 Now the makefiles are created (by configure) and you can compile
 379 the library by typing:
 380
 381     make
 382
 383 make yourself some coffee, as it will take some time. On an old
 384 386SX possibly two weeks. During compilation, you'll get a few
 385 warning messages depending in your compiler.
 386
 387 If you want to be more selective, you can change into a specific
 388 directory and type "make" there.
 389
 390 Then you may install the library and its header files under
 391 /usr/local/include/wx and /usr/local/lib respectively. You
 392 have to log in as root (i.e. run "su" and enter the root
 393 password) and type
 394
 395         make install
 396
 397 You can remove any traces of wxWidgets by typing
 398
 399         make uninstall
 400
 401 If you want to save disk space by removing unnecessary
 402 object-files:
 403
 404 make clean
 405
 406 in the various directories will do the work for you.
 407
 408 * Creating a new Project
 409 --------------------------
 410
 411 1) The first way uses the installed libraries and header files
 412 automatically using wx-config
 413
 414 g++ myfoo.cpp `wx-config --cxxflags --libs` -o myfoo
 415
 416 Using this way, a make file for the minimal sample would look
 417 like this
 418
 419 CC = gcc
 420
 421 minimal: minimal.o
 422         $(CC) -o minimal minimal.o `wx-config --libs`
 423
 424 minimal.o: minimal.cpp mondrian.xpm
 425         $(CC) `wx-config --cxxflags` -c minimal.cpp -o minimal.o
 426
 427 clean:
 428         rm -f *.o minimal
 429
 430 If your application uses only some of wxWidgets libraries, you can
 431 specify required libraries when running wx-config. For example,
 432 `wx-config --libs=html,core` will only output link command to link
 433 with libraries required by core GUI classes and wxHTML classes. See
 434 the manual for more information on the libraries.
 435
 436 2) The other way creates a project within the source code
 437 directories of wxWidgets. For this endeavour, you'll need
 438 GNU autoconf version 2.14 and add an entry to your Makefile.in
 439 to the bottom of the configure.in script and run autoconf
 440 and configure before you can type make.
 441
 442 ----------------------
 443
 444 In the hope that it will be useful,
 445
 446         Robert Roebling
 447