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

Reformat configure options description

Browse Source 
No changes in contents, just use a list for configure options rather
than preformatted text block.
This commit is contained in:
Vadim Zeitlin
2021-09-04 17:47:19 +01:00
parent 45f7ec9bdb
commit 91923dc3f1
1 changed files with 71 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
docs/gtk/install.md
View File

@@ -127,12 +127,12 @@ more information).
The following options can be used to specify the kind and number The following options can be used to specify the kind and number
of libraries to build: of libraries to build:
--disable-shared Do not create shared libraries, but * `--disable-shared` \n
build static libraries instead. Do not create shared libraries, but build static libraries instead.
--enable-monolithic Build wxWidgets as single library instead * `--enable-monolithic` \n
of as several smaller libraries (which is Build wxWidgets as single library instead of as several smaller libraries
the default since wxWidgets 2.5.0). (which is the default since wxWidgets 2.5.0).
Options for third party dependencies: wxWidgets may use other Options for third party dependencies: wxWidgets may use other
libraries present on the current system, see the @ref gtk_prereq libraries present on the current system, see the @ref gtk_prereq
@@ -143,121 +143,114 @@ minimize external dependencies. By default, system versions will be
used if available, but `--with-xxx=builtin` configure option may be used if available, but `--with-xxx=builtin` configure option may be
used to override this. used to override this.
--disable-sys-libs Don't use system libraries when there is * `--disable-sys-libs` \n
a built-in version included in wxWidgets. Don't use system libraries when there is a built-in version included in
This is equivalent to using --with-xxx=builtin wxWidgets. This is equivalent to using --with-xxx=builtin for all libraries
for all libraries that have built-in versions. that have built-in versions. Note that other system libraries can, and
Note that other system libraries can, typically will, still be used if found.
and typically will, still be used if
found.
--without-libpng Disables PNG image format code. * `--without-libpng` \n
Don't use neither the system nor the builtin Disables PNG image format code. Don't use neither the system nor the builtin
libpng (although GTK itself still uses it). libpng (although GTK itself still uses it).
--without-libjpeg Disables JPEG image format code. * `--without-libjpeg` \n
Don't use libjpeg. Disables JPEG image format code. Don't use libjpeg.
--without-libtiff Disables TIFF image format code. * `--without-libtiff` \n
Don't use libtiff. Disables TIFF image format code. Don't use libtiff.
--without-expat Disable XML classes based on Expat parser. * `--without-expat` \n
Don't use expat library. Disable XML classes based on Expat parser. Don't use expat library.
--without-liblzma Disable LZMA compression support. * `--without-liblzma` \n
Don't use liblzma. Disable LZMA compression support. Don't use liblzma.
--without-libcurl Don't use libcurl even if it's available. * `--without-libcurl` \n
Disables wxWebRequest. Don't use libcurl even if it's available. Disables wxWebRequest.
--without-opengl Disable OpenGL integration with wxGLCanvas. * `--without-opengl` \n
Don't use OpenGL or EGL libraries. Disable OpenGL integration with wxGLCanvas. Don't use OpenGL or EGL libraries.
--disable-glcanvasegl Disable EGL support even if it is available * `--disable-glcanvasegl` \n
(it would be used if it is, by default). Disable EGL support even if it is available (it would be used if it is, by default).
--disable-mediactrl Disable wxMediaCtrl. * `--disable-mediactrl` \n
Don't use GStreamer libraries. Disable wxMediaCtrl. Don't use GStreamer libraries.
--disable-webview Disable wxWebView. * `--disable-webview` \n
Don't use webkit2gtk and its multiple Disable wxWebView. Don't use webkit2gtk and its multiple dependencies.
dependencies.
Normally, you won't have to choose a toolkit, because configure Normally, you won't have to choose a toolkit, because configure
defaults to wxGTK anyhow. However you need to use this option to defaults to wxGTK anyhow. However you need to use this option to
explicitly specify the version of GTK to use, e.g.: explicitly specify the version of GTK to use, e.g.:
--with-gtk=3 Use GTK 3. Default. * `--with-gtk=3` \n Use GTK 3. Default.
--with-gtk=2 Use GTK 2. * `--with-gtk=2` \n Use GTK 2.
--with-gtk=1 Use GTK 1.2. Obsolete. * `--with-gtk=1` \n Use GTK 1.2. Obsolete.
Some other general compilation options: Some other general compilation options:
--disable-optimise Do not optimise the code. Can be useful * `--disable-optimise` \n
for debugging but shouldn't be used Do not optimise the code. Can be useful for debugging but shouldn't be used
for production builds. for production builds.
--disable-unicode Disable Unicode support. Not recommended. * `--disable-unicode` \n
Disable Unicode support. Not recommended.
--enable-no_rtti Enable compilation without creation of * `--enable-no_rtti` \n
C++ RTTI information in object files. Enable compilation without creation of C++ RTTI information in object files.
This will speed-up compilation and reduce This will speed-up compilation and reduce binary size.
binary size.
--enable-no_exceptions Enable compilation without creation of * `--enable-no_exceptions` \n
C++ exception information in object files. Enable compilation without creation of C++ exception information in object
This will speed-up compilation and reduce files. This will speed-up compilation and reduce binary size.
binary size.
--enable-debug_info Add debug info to object files and * `--enable-debug_info` \n
executables for use with debuggers Add debug info to object files and executables for use with debuggers such
such as gdb (or its many frontends). as gdb (or its many frontends).
--enable-debug_flag Define __DEBUG__ and __WXDEBUG__ when * `--enable-debug_flag` \n
compiling. This enable wxWidgets' very Define __DEBUG__ and __WXDEBUG__ when compiling. This enable wxWidgets' very
useful internal debugging tricks (such useful internal debugging tricks (such as automatically reporting illegal
as automatically reporting illegal calls) calls) to work. Note that program and library must be compiled with the same
to work. Note that program and library debug options.
must be compiled with the same debug
options.
--enable-debug Same as --enable-debug_info and * `--enable-debug` \n
--enable-debug_flag together. Unless you have Same as --enable-debug_info and --enable-debug_flag together. Unless you
some very specific needs, you should use this have some very specific needs, you should use this option instead of
option instead of --enable-debug_info/flag ones --enable-debug_info/flag ones separately.
separately.
To reduce the final libraries (or executables, when linking To reduce the final libraries (or executables, when linking
statically) size, many wxWidgets features may be disabled. Here statically) size, many wxWidgets features may be disabled. Here
is a list of some of them: is a list of some of them:
--disable-pnm Disables PNM image format code. * `--disable-pnm` \n Disables PNM image format code.
--disable-gif Disables GIF image format code. * `--disable-gif` \n Disables GIF image format code.
--disable-pcx Disables PCX image format code. * `--disable-pcx` \n Disables PCX image format code.
--disable-iff Disables IFF image format code. * `--disable-iff` \n Disables IFF image format code.
--disable-resources Disables the use of *.wxr type resources. * `--disable-resources` \n Disables the use of *.wxr type resources.
--disable-threads Disables threads. Will also disable sockets. * `--disable-threads` \n Disables threads. Will also disable sockets.
--disable-sockets Disables sockets. * `--disable-sockets` \n Disables sockets.
--disable-dnd Disables Drag'n'Drop. * `--disable-dnd` \n Disables Drag'n'Drop.
--disable-clipboard Disables Clipboard. * `--disable-clipboard` \n Disables Clipboard.
--disable-streams Disables the wxStream classes. * `--disable-streams` \n Disables the wxStream classes.
--disable-file Disables the wxFile class. * `--disable-file` \n Disables the wxFile class.
--disable-textfile Disables the wxTextFile class. * `--disable-textfile` \n Disables the wxTextFile class.
--disable-intl Disables the internationalisation. * `--disable-intl` \n Disables the internationalisation.
--disable-validators Disables validators. * `--disable-validators` \n Disables validators.
Please remember that the full list of options can be seen in Please remember that the full list of options can be seen in
`configure --help` output. `configure --help` output.