Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update and simplify wxGTK installation instructions too

Browse Source 
Remove obsolete information, add more useful configure options and a
link to CMake.
This commit is contained in:
Vadim Zeitlin
2020-12-01 01:28:19 +01:00
parent 9c586177da
commit bdbf00090e
1 changed files with 122 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

348
docs/gtk/install.md
View File

@@ -3,18 +3,6 @@ wxWidgets for GTK installation {#plat_gtk_install}
[TOC] [TOC]
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
problem first and then send a patch to the author.
When sending bug reports tell us what version of wxWidgets you are
using (including the beta) and what compiler on what system. One
example: wxGTK 3.0.5, GCC 9.3.1, Fedora 31
Installation {#gtk_install} Installation {#gtk_install}
============ ============
@@ -23,7 +11,7 @@ The simplest case {#gtk_simple}
------------------- -------------------
If you compile wxWidgets 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): install instructions just do the following in wxWidgets directory:
> mkdir buildgtk > mkdir buildgtk
> cd buildgtk > cd buildgtk
@@ -47,70 +35,39 @@ If you want to remove wxWidgets on Unix you can do this:
Note that by default, GTK 3 is used. GTK 2 can be specified Note that by default, GTK 3 is used. GTK 2 can be specified
with --with-gtk=2. with --with-gtk=2.
The expert case {#gtk_expert} If you use CMake, please see @ref overview_cmake for
----------------- building wxWidgets using it.
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. To do this, create a separate 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 and one without.
For building three versions (one GTK, one Motif and a debug version of the GTK Troubleshooting {#gtk_errors_simple}
source) you'd do this: ---------------
mkdir buildmotif IMPORTANT NOTE:
cd buildmotif
../configure --with-motif
make
cd ..
mkdir buildgtk When sending bug reports tell us what version of wxWidgets you are
cd buildgtk using (including the beta) and what compiler on what system. One
../configure --with-gtk example: wxGTK 3.0.5, GCC 9.3.1, Fedora 31.
make
cd ..
mkdir buildgtkd For any configure errors: please look at `config.log` file which was generated
cd buildgtkd
../configure --with-gtk --enable-debug
make
cd ..
Note that you can install all those libraries concurrently, you just need to
pass the appropriate flags when using them.
The simplest errors {#gtk_errors_simple}
---------------------
For any configure errors: please look at config.log file which was generated
during configure run, it usually contains some useful information. during configure run, it usually contains some useful information.
configure reports, that you don't have GTK 1.2/2.0/3.0 installed although you If configure reports that you don't have GTK installed, please
are very sure you have. Well, you have installed it, but you also have another check that the appropriate _development_ package is available on
version of the GTK installed, which you may need to remove including other your system and not just the GTK libraries themselves. You can
versions of glib (and its headers). Or maybe you installed it in a non-default use `pkg-config --modversion gtk+-3.0` (or `2.0`) to check that
location and configure can't find it there, so please check that your PATH this is the case.
variable includes the path to the correct gtk-config/pkg-config. Also check
that your LD_LIBRARY_PATH or equivalent variable contains the path to GTK
libraries if they were installed in a non-default location.
You get errors from make: please use GNU make instead of the native make You get errors from make: please use GNU make instead of the native make
program. Currently wxWidgets can be built only with GNU make, BSD make and program. Currently wxWidgets can be built only with GNU make, BSD make and
Solaris make. Other versions might work or not (any which don't have VPATH Solaris make. Other versions might work or not.
support definitely won't).
You get errors during compilation: The reason is that you probably have a You get immediate crashes when starting any sample or application: This may
broken compiler. GCC 2.8 and earlier versions and egcs are likely to cause be due to having compiled the library with different flags or
problems due to incomplete support for C++ and optimisation bugs. Best to use compiler options than your program or using the headers from a
GCC 2.95 or later. different version of the library that is being used during
run-time. If you have multiple versions of wxWidgets installed,
please try uninstalling the ones you don't need and rebuilding.
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 simplest program {#gtk_simple_app} The simplest program {#gtk_simple_app}
---------------------- ----------------------
@@ -119,90 +76,43 @@ Now create your super-application myfoo.cpp and compile anywhere with
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
GUI libraries {#gtk_libs_gui}
---------------
wxWidgets/GTK requires the GTK library to be installed on your system.
You can get the newest version of GTK from the GTK homepage at:
http://www.gtk.org
Additional libraries {#gtk_libs_misc}
----------------------
wxWidgets/Gtk 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
make
su <type root password>
make install
ldconfig
exit
Building wxGTK on Cygwin {#gtk_cygwin} Building wxGTK on Cygwin {#gtk_cygwin}
-------------------------- --------------------------
The normal build instructions should work fine on Cygwin. The one difference The normal build instructions should work fine on Cygwin. The one difference
with Cygwin is that when using the "--enable-shared" configure option (which with Cygwin is that when using the "--enable-shared" configure option (which
is the default) the API is exported explicitly using __declspec(dllexport) is the default) the API is exported explicitly using `__declspec(dllexport)`
rather than all global symbols being available. rather than all global symbols being available.
This shouldn't make a difference using the library and should be a little 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 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 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 problem by setting `LDFLAGS=-Wl,--export-all-symbols`. Please also let us know
about it on the wx-dev mailing list. about it on the wx-dev mailing list.
Create your configuration {#gtk_config}
---------------------------
Usage: Configure options {#gtk_options}
./configure options
If you want to use system's C and C++ compiler,
set environment variables CC and CXX as
% setenv CC cc
% setenv CXX CC
% ./configure [options]
to see all the options please use:
./configure --help
It is recommended to build wxWidgets in another directory (maybe a
subdirectory of your wxWidgets installation) as this allows you to
have multiple configurations (for example, debug and release or GTK
and Motif) simultaneously.
General options {#gtk_options}
----------------- -----------------
Given below are the commands to change the default behaviour, This section documents some of the most important configure
i.e. if it says "--disable-threads" it means that threads options. It is not exhaustive, please refer to `configure --help`
are enabled by default. for the full list of options.
Normally, you won't have to choose a toolkit, because when Note that the options documented below are given in the form
you download wxGTK, it will default to --with-gtk etc. But indicating how to change the default behaviour, i.e. if it says
if you use the git repository you have to choose a toolkit. "--disable-optimise" it means that optimizations are enabled by
You must do this by running configure with either of: default.
--with-gtk=3 Use GTK 3. Default. All standard configure options are supported, e.g. you can choose
--with-gtk=2 Use GTK 2. `--prefix` to select the directory to install the libraries to.
--with-gtk=1 Use GTK 1.2. Also note that cross-compiling is fully supported, just specify
the `--host` option as usual (please refer to autoconf manual for
more information).
The following options handle the kind of library you want to build. The following options can be used to specify the kind and number
of libraries to build:
--disable-threads Compile without thread support.
--disable-shared Do not create shared libraries, but --disable-shared Do not create shared libraries, but
build static libraries instead. build static libraries instead.
@@ -211,16 +121,48 @@ The following options handle the kind of library you want to build.
of as several smaller libraries (which is of as several smaller libraries (which is
the default since wxWidgets 2.5.0). the default since wxWidgets 2.5.0).
--disable-optimise Do not optimise the code. Can Options for third party dependencies: wxWidgets may use other
sometimes be useful for debugging libraries present on the current system. For some of these
and is required on some architectures libraries, wxWidgets also provides built-in versions, that can be
such as Sun with gcc 2.8.X which linked into wx libraries themselves, which can be useful to
would otherwise produce segvs. minimize external dependencies.
--enable-unicode Enable Unicode support. --disable-sys-libs Don't use system libraries at all.
Use built-in ones when possible or
disable support for the corresponding
feature otherwise.
--enable-profile Add profiling info to the object --without-libpng Disables PNG image format code.
files. Currently broken, I think. Don't use libpng (although GTK
itself still uses it).
--without-libjpeg Disables JPEG image format code.
Don't use libjpeg.
--without-libtiff Disables TIFF image format code.
Don't use libtiff.
--without-expat Disable XML classes based on Expat parser.
Don't use expat library.
--without-liblzma Disable LZMA compression support.
Don't use liblzma.
Normally, you won't have to choose a toolkit, because configure
defaults to wxGTK anyhow. However you need to use this option to
explicitly specify the version of GTK to use, e.g.:
--with-gtk=3 Use GTK 3. Default.
--with-gtk=2 Use GTK 2.
--with-gtk=1 Use GTK 1.2. Obsolete.
Some other general compilation options:
--disable-optimise Do not optimise the code. Can be useful
for debugging but shouldn't be used
for production builds.
--disable-unicode Disable Unicode support. Not recommended.
--enable-no_rtti Enable compilation without creation of --enable-no_rtti Enable compilation without creation of
C++ RTTI information in object files. C++ RTTI information in object files.
@@ -230,18 +172,7 @@ The following options handle the kind of library you want to build.
--enable-no_exceptions Enable compilation without creation of --enable-no_exceptions Enable compilation without creation of
C++ exception information in object files. C++ exception information in object files.
This will speed-up compilation and reduce This will speed-up compilation and reduce
binary size. Also fewer crashes during the binary size.
actual compilation...
--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_info Add debug info to object files and --enable-debug_info Add debug info to object files and
executables for use with debuggers executables for use with debuggers
@@ -261,22 +192,9 @@ The following options handle the kind of library you want to build.
option instead of --enable-debug_info/flag ones option instead of --enable-debug_info/flag ones
separately. separately.
Feature Options {#gtk_feature_options} To reduce the final libraries (or executables, when linking
----------------- statically) size, many wxWidgets features may be disabled. Here
is a list of some of them:
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 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-libtiff Disables TIFF image format code.
--without-expat Disable XML classes based on Expat parser.
--disable-pnm Disables PNM image format code. --disable-pnm Disables PNM image format code.
@@ -296,8 +214,6 @@ are
--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.
@@ -308,82 +224,62 @@ are
--disable-validators Disables validators. --disable-validators Disables validators.
--disable-accel Disables accelerators support. Please remember that the full list of options can be seen in
`configure --help` output.
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 {#gtk_compling}
-----------
The following must be done in the base directory (e.g. ~/wxGTK Building the libraries {#gtk_compling}
or ~/wxWin or whatever) ----------------------
Now the makefiles are created (by configure) and you can compile After running configure, just run `make` from the same directory.
the library by typing: Building can take some time and it's strongly recommended to use
`--jobs` option with GNU make, e.g. `make -j8` if you have 8
make logical CPU cores.
make yourself some coffee, as it will take some time. On an old
386SX possibly two weeks. During compilation, you'll get a few
warning messages depending in your compiler.
If you want to be more selective, you can change into a specific
directory and type "make" there.
Then you may install the library and its header files under Then you may install the library and its header files under
/usr/local/include/wx and /usr/local/lib respectively. You `/usr/local/include/wx` and `/usr/local/lib` respectively. You
have to log in as root (i.e. run "su" and enter the root have to perform the following command as root, using either `su`
password) and type or `sudo`:
make install make install
You can remove any traces of wxWidgets by typing After installing, you can run `make clean` in the original
directory or just remove it entirely if you don't plan to build
wxWidgets again in the near future.
make uninstall Note that installing the library is _not_ required and it can
also be used from the build directory by simply specifying the
full path to `wx-config` script located in it when building your
application.
If you want to save disk space by removing unnecessary
object-files:
make clean Building your project {#gtk_new_project}
---------------------
in the various directories will do the work for you. You need to use the compilation flags returned by `wx-config
--cxxflags` and linking flags returned by `wx-config --libs`,
Creating a new Project {#gtk_new_project} which may be combined into a single invocation:
--------------------------
1. The first way uses the installed libraries and header files
automatically using wx-config
g++ myfoo.cpp `wx-config --cxxflags --libs` -o myfoo g++ myfoo.cpp `wx-config --cxxflags --libs` -o myfoo
Using this way, a make file for the minimal sample would look A simple makefile for a program using wxWidgets could be written
like this in the following way:
CXX = g++ ```make
program: program.o
$(CXX) -o program program.o `wx-config --libs`
minimal: minimal.o program.o: program.cpp
$(CXX) -o minimal minimal.o `wx-config --libs` $(CXX) `wx-config --cxxflags` -c program.cpp -o program.o
minimal.o: minimal.cpp clean:
$(CXX) `wx-config --cxxflags` -c minimal.cpp -o minimal.o $(RM) program.o program
.PHONY: clean
```
clean: If your application uses only some of wxWidgets libraries, you can
rm -f *.o minimal specify required libraries when running wx-config. For example,
`wx-config --libs=html,core` will only output link command to link
If your application uses only some of wxWidgets libraries, you can with libraries required by core GUI classes and wxHTML classes. See
specify required libraries when running wx-config. For example, the manual for more information on the libraries.
`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 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.