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

Integrate X11 and Motif install instructions into doxygen

Browse Source
This commit is contained in:
Tobias Taschner
2018-10-03 19:42:32 +02:00
parent 141b5bdf0f
commit da04a0a8e7
4 changed files with 189 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/Doxyfile
View File

@@ -294,9 +294,11 @@ INPUT = mainpages \
overviews \
../gtk \
../ios \
../motif \
../msw \
../osx \
../qt \
../x11 \
../../interface
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.md

9
docs/doxygen/mainpages/platdetails.h
View File

@@ -80,8 +80,9 @@ In order to configure wxWidgets to compile wxX11 you will need to type:
@verbatim configure --with-x11 --with-universal @endverbatim
For further information, please see the files in @c docs/x11 in the
distribution. There is also a page on the use of wxWidgets for embedded
@subpage plat_x11_install "Build Instructions"
There is also a page on the use of wxWidgets for embedded
applications on the wxWidgets web site.
@@ -92,8 +93,8 @@ wxMotif is a port of wxWidgets for X11 systems using Motif libraries. Motif
libraries provide a clean and fast user interface at the expense of the beauty
and candy of newer interfaces like GTK.
For further information, please see the files in @c docs/motif in the
distribution.
@subpage plat_motif_install "Build Instructions"

57
docs/motif/install.txt → docs/motif/install.md
View File

@@ -1,6 +1,8 @@
wxWidgets for Motif installation
wxWidgets for Motif installation {#plat_motif_install}
--------------------------------
[TOC]
IMPORTANT NOTE:
If you experience problems installing, please re-read these
@@ -40,10 +42,10 @@ First steps
config.log file).
COMPILING USING CONFIGURE
Compiling using configure {#motif_configure}
=========================
* The simplest case
The simplest case {#motif_simple}
-------------------
If you compile wxWidgets on Linux for the first time and don't like to read
@@ -71,7 +73,7 @@ If you want to remove wxWidgets on Unix you can do this:
> ldconfig
> exit
* The expert case
The expert case {#motif_expert}
-----------------
If you want to do some more serious cross-platform programming with wxWidgets,
@@ -105,7 +107,7 @@ cd ..
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.
* The simplest errors
The simplest errors {#motif_error_simple}
---------------------
You get errors during compilation: The reason is that you probably have a
@@ -115,18 +117,18 @@ 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
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
The simplest program {#motif_simple_app}
----------------------
Now create your super-application myfoo.app and compile anywhere with
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
* General
General {#motif_general}
---------
The Unix variants of wxWidgets use GNU configure. If you have problems with
@@ -142,7 +144,7 @@ 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
GUI libraries {#motif_libs_gui}
---------------
wxWidgets/Motif requires the Motif library to be installed on your system. As
@@ -153,7 +155,7 @@ You can get the newest version of the Lesstif from the lesstif homepage at:
http://lesstif.sourceforge.net/
* Additional libraries
Additional libraries {#motif_libs_misc}
----------------------
wxWidgets/Motif requires a thread library and X libraries known to work with
@@ -171,7 +173,7 @@ make install
ldconfig
exit
* Building wxMotif on Cygwin
Building wxMotif on Cygwin {#motif_cygwin}
----------------------------
The normal build instructions should work fine on Cygwin. The one difference
@@ -185,10 +187,11 @@ 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
Create your configuration {#motif_config}
---------------------------
Usage:
./configure [options]
If you want to use system's C and C++ compiler,
@@ -216,7 +219,7 @@ Configure will complain if the system variable OSTYPE has
not been defined. And Make in some circumstances as well...
* General options
General options {#motif_options}
-------------------
Given below are the commands to change the default behaviour,
@@ -289,7 +292,7 @@ The following options handle the kind of library you want to build.
must be compiled with the same debug
options.
* Feature Options
Feature Options {#motif_feature_options}
-----------------
Many of the configure options have been thoroughly tested
@@ -338,7 +341,7 @@ Please see the output of "./configure --help" for comprehensive list
of all configurable options.
* Compiling
Compiling {#motif_compile}
-----------
The following must be done in the base directory (e.g. ~/wxMotif
@@ -374,10 +377,10 @@ object-files:
in the various directories will do the work for you.
* Creating a new Project
Creating a new Project {#motif_new_project}
------------------------
1) The first way uses the installed libraries and header files
1. The first way uses the installed libraries and header files
automatically using wx-config
g++ myfoo.cpp `wx-config --libs` `wx-config --cxxflags` -o myfoo
@@ -402,13 +405,13 @@ specify required libraries when running wx-config. For example,
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
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.
* Further notes by Julian Smart
Further notes by Julian Smart {#motif_notes}
---------------------------------
- You may find the following script useful for compiling wxMotif,
@@ -416,7 +419,6 @@ and configure before you can type make.
permissions). Make this script executable with the command
chmod a+x makewxmotif.
-------:x-----Cut here-----:x-----
# makewxmotif
# Sets permissions (in case we extracted wxMotif from zip files)
# and makes wxMotif.
@@ -429,12 +431,11 @@ and configure before you can type make.
chmod a+x configure config.sub config.guess
./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 wxWidgets library, use --disable-shared.
Troubleshooting
Troubleshooting {#motif_troubleshoot}
---------------
- Solaris compilation with gcc: if the compiler has problems with the variable
@@ -458,20 +459,10 @@ Troubleshooting
If you find any incorrect instances, though, such as a
missing 'const' in an overridden function, please let us know.
Other Notes
Other Notes {#motif_misc}
-----------
- 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
-----------
Please send bug reports with a description of your environment,
compiler and the error message(s) to the developers mailing list at:
https://www.wxwidgets.org/support/mailing-lists/
Julian Smart, Robert Roebling and Vadim Zeitlin, November 1999.

57
docs/x11/install.txt → docs/x11/install.md
View File

@@ -1,6 +1,8 @@
wxWidgets for X11 installation
wxWidgets for X11 installation {#plat_x11_install}
------------------------------
[TOC]
IMPORTANT NOTE:
If you experience problems installing, please re-read these
@@ -13,7 +15,7 @@ IMPORTANT NOTE:
using (including the beta) and what compiler on what system. One
example: wxX11 2.8.0, gcc 2.95.4, Redhat 6.2
First steps
First steps {#x11_first_steps}
-----------
- Download wxX11-x.y.z.tgz, where x.y.z is the version number.
@@ -34,10 +36,10 @@ First steps
information about your platform and the (relevant part of) contents of
config.log file).
COMPILING USING CONFIGURE
Compiling using configure {#x11_configure}
=========================
* The simplest case
The simplest case {#x11_simple}
-------------------
If you compile wxWidgets on Linux for the first time and don't like to read
@@ -65,7 +67,7 @@ If you want to remove wxWidgets on Unix you can do this:
> ldconfig
> exit
* The expert case
The expert case {#x11_expert}
-----------------
If you want to do some more serious cross-platform programming with wxWidgets,
@@ -98,7 +100,7 @@ cd buildgtkd
make
cd ..
* The simplest errors
The simplest errors {#x11_errors}
---------------------
You get errors during compilation: The reason is that you probably have a
@@ -108,18 +110,18 @@ 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
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
The simplest program {#x11_simple_app}
----------------------
Now create your super-application myfoo.cpp and compile anywhere with
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
* General
General {#x11_general}
---------
The Unix variants of wxWidgets use GNU configure. If you have problems with
@@ -134,12 +136,12 @@ report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF
YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF X, WHAT DISTRIBUTION
YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried...
* GUI libraries
GUI libraries {#x11_libs_gui}
---------------
wxWidgets/X11 requires the X11 library to be installed on your system.
* Additional libraries
Additional libraries {#x11_libs_misc}
----------------------
wxWidgets/X11 requires a thread library and X libraries known to work with
@@ -157,7 +159,7 @@ make install
ldconfig
exit
* Building wxX11 on Cygwin
Building wxX11 on Cygwin {#x11_cygwin}
--------------------------
The normal build instructions should work fine on Cygwin. The one difference
@@ -171,10 +173,11 @@ 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
Create your configuration {#x11_config}
---------------------------
Usage:
./configure [options]
If you want to use system's C and C++ compiler,
@@ -202,7 +205,7 @@ Configure will complain if the system variable OSTYPE has
not been defined. And Make in some circumstances as well...
* General options
General options {#x11_options}
-----------------
Given below are the commands to change the default behaviour,
@@ -268,7 +271,7 @@ The following options handle the kind of library you want to build.
must be compiled with the same debug
options.
* Feature Options
Feature Options {#x11_feature_options}
-----------------
Many of the configure options have been thoroughly tested
@@ -320,7 +323,7 @@ Please see the output of "./configure --help" for comprehensive list
of all configurable options.
* Compiling
Compiling {#x11_compiling}
-----------
The following must be done in the base directory (e.g. ~/wxX11
@@ -356,10 +359,10 @@ object-files:
in the various directories will do the work for you.
* Creating a new Project
Creating a new Project {#x11_new_app}
------------------------
1) The first way uses the installed libraries and header files
1. The first way uses the installed libraries and header files
automatically using wx-config
g++ myfoo.cpp `wx-config --libs` `wx-config --cxxflags` -o myfoo
@@ -387,13 +390,13 @@ specify required libraries when running wx-config. For example,
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
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.
* Further notes by Julian Smart
Further notes by Julian Smart {#x11_notes}
-------------------------------
- You may find the following script useful for compiling wxX11,
@@ -401,7 +404,6 @@ and configure before you can type make.
permissions). Make this script executable with the command
chmod a+x makewxx11.
-------:x-----Cut here-----:x-----
# makewxx11
# Sets permissions (in case we extracted wxX11 from zip files)
# and makes wxX11.
@@ -414,12 +416,11 @@ and configure before you can type make.
chmod a+x configure config.sub config.guess
./configure --with-x11 --with-shared --with-debug_flag --with-debug_info --enable-debug --without-threads --without-sockets --without-odbc
make
-------:x-----Cut here-----:x-----
This script will build wxX11 using shared libraries. If you want to build
a static wxWidgets library, use --disable-shared.
Troubleshooting
Troubleshooting {#x11_troubleshooting}
---------------
- Solaris compilation with gcc: if the compiler has problems with the variable
@@ -437,7 +438,7 @@ Troubleshooting
If you find any incorrect instances, though, such as a
missing 'const' in an overridden function, please let us know.
Other Notes
Other Notes {#x11_misc_notes}
-----------
- Debugging mode is switched on by default in the makefiles, but using
@@ -448,11 +449,3 @@ Other Notes
configure system, change --with-debug_flag to --without-debug_flag
and --with-debug_info to --without-debug_info in the makewxx11
script).
Bug reports
-----------
Please send bug reports with a description of your environment,
compiler and the error message(s) to the developers mailing list at:
https://www.wxwidgets.org/support/mailing-lists/