diff options
Diffstat (limited to 'config_help.txt')
| -rw-r--r-- | config_help.txt | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/config_help.txt b/config_help.txt new file mode 100644 index 0000000000..5725e9213f --- /dev/null +++ b/config_help.txt @@ -0,0 +1,291 @@ +Usage: configure [options] [assignments] + +Configure understands variable assignments like VAR=value on the command line. +These override any values possibly obtained from pkg-config. The variables +are mentioned in the descriptions of the options they relate to. + +It is also possible to manipulate any QMAKE_* variable, to amend the values +from the mkspec for the build of Qt itself, e.g., QMAKE_CXXFLAGS+=-g3. + +Top-level installation directories: + -prefix <dir> ...... The deployment directory, as seen on the target device. + [/usr/local/Qt-$QT_VERSION, $PWD if -developer-build] + -extprefix <dir> ... The installation directory, as seen on the host machine. + [SYSROOT/PREFIX] + -hostprefix [dir] .. The installation directory for build tools running on + the host machine. If [dir] is not given, the current + build directory will be used. [EXTPREFIX] + -external-hostbindir <path> ... Path to Qt tools built for this machine. + Use this when -platform does not match the current + system, i.e., to make a Canadian Cross Build. + +Fine tuning of installation directory layout. Note that all directories +except -sysconfdir should be located under -prefix/-hostprefix: + + -bindir <dir> ......... Executables [PREFIX/bin] + -headerdir <dir> ...... Header files [PREFIX/include] + -libdir <dir> ......... Libraries [PREFIX/lib] + -archdatadir <dir> .... Arch-dependent data [PREFIX] + -plugindir <dir> ...... Plugins [ARCHDATADIR/plugins] + -libexecdir <dir> ..... Helper programs [ARCHDATADIR/bin on Windows, + ARCHDATADIR/libexec otherwise] + -importdir <dir> ...... QML1 imports [ARCHDATADIR/imports] + -qmldir <dir> ......... QML2 imports [ARCHDATADIR/qml] + -datadir <dir> ........ Arch-independent data [PREFIX] + -docdir <dir> ......... Documentation [DATADIR/doc] + -translationdir <dir> . Translations [DATADIR/translations] + -sysconfdir <dir> ..... Settings used by Qt programs [PREFIX/etc/xdg] + -examplesdir <dir> .... Examples [PREFIX/examples] + -testsdir <dir> ....... Tests [PREFIX/tests] + + -hostbindir <dir> ..... Host executables [HOSTPREFIX/bin] + -hostlibdir <dir> ..... Host libraries [HOSTPREFIX/lib] + -hostdatadir <dir> .... Data used by qmake [HOSTPREFIX] + +Conventions for the remaining options: When an option's description is +followed by a list of values in brackets, the interpretation is as follows: +'yes' represents the bare option; all other values are possible prefixes to +the option, e.g., -no-gui. Alternatively, the value can be assigned, e.g., +--gui=yes. Values are listed in the order they are tried if not specified; +'auto' is a shorthand for 'yes/no'. Solitary 'yes' and 'no' represent binary +options without auto-detection. + +Configure meta: + + -help, -h ............ Display this help screen + -verbose, -v ......... Print verbose messages during configuration + -continue ............ Continue configure despite errors + -redo ................ Re-configure with previously used options. + Additional options may be passed, but will not be + saved for later use by -redo. + -recheck ............. Discard cached negative configure test results. + Use this after installing missing dependencies. + -recheck-all ......... Discard all cached configure test results. + +Build options: + + -opensource .......... Build the Open-Source Edition of Qt + -commercial .......... Build the Commercial Edition of Qt + -confirm-license ..... Automatically acknowledge the license + + -release ............. Build Qt with debugging turned off [yes] + -debug ............... Build Qt with debugging turned on [no] + -debug-and-release ... Build two versions of Qt, with and without + debugging turned on [yes] (Apple and Windows only) + -optimized-tools ..... Build optimized host tools even in debug build [no] + -force-debug-info .... Create symbol files for release builds [no] + -separate-debug-info . Split off debug information to separate files [no] + -strip ............... Strip release binaries of unneeded symbols [yes] + -force-asserts ....... Enable Q_ASSERT even in release builds [no] + -developer-build ..... Compile and link Qt for developing Qt itself + (exports for auto-tests, extra checks, etc.) [no] + + -shared .............. Build shared Qt libraries [yes] (no for UIKit) + -static .............. Build static Qt libraries [no] (yes for UIKit) + -framework ........... Build Qt framework bundles [yes] (Apple only) + + -platform <target> ... Select host mkspec [detected] + -host-option <key=value> ..... Add option for the host mkspec + -xplatform <target> .. Select target mkspec when cross-compiling [PLATFORM] + -device <name> ....... Cross-compile for device <name> + -device-option <key=value> ... Add option for the device mkspec + + -qtnamespace <name> .. Wrap all Qt library code in 'namespace <name> {...}'. + -qtlibinfix <infix> .. Rename all libQt5*.so to libQt5*<infix>.so. + + -testcocoon .......... Instrument with the TestCocoon code coverage tool [no] + -gcov ................ Instrument with the GCov code coverage tool [no] + -sanitize {address|thread|memory|undefined} + Instrument with the specified compiler sanitizer. + + -c++std <edition> .... Select C++ standard <edition> [c++1z/c++14/c++11] + (Not supported with MSVC) + -rtti ................ Build with Runtime Type Information [yes] (MSVC only) + + -sse2 ................ Use SSE2 instructions [auto] + -sse3/-ssse3/-sse4.1/-sse4.2/-avx/-avx2/-avx512 + Enable use of particular x86 instructions [auto] + Enabled ones are still subject to runtime detection. + -mips_dsp/-mips_dspr2 Use MIPS DSP/rev2 instructions [auto] + + -qreal <type> ........ typedef qreal to the specified type. [double] + Note: this affects binary compatibility. + + -R <string> .......... Add an explicit runtime library path to the Qt + libraries. Supports paths relative to LIBDIR. + -rpath ............... Link Qt libraries and executables using the library + install path as a runtime library path. Similar to + -R LIBDIR. On Apple platforms, disabling this implies + using absolute install names (based in LIBDIR) for + dynamic libraries and frameworks. [auto] + + -reduce-exports ...... Reduce amount of exported symbols [auto] + -reduce-relocations .. Reduce amount of relocations [auto] (Unix only) + + -plugin-manifests .... Embed manifests into plugins [no] (Windows only) + -static-runtime ...... With -static, use static runtime [no] (Windows only) + + -pch ................. Use precompiled headers [auto] + -ltcg ................ Use Link Time Code Generation [no] + -use-gold-linker ..... Use the GNU gold linker [auto] + -incredibuild-xge .... Use the IncrediBuild XGE [no] (Windows only) + -make-tool <tool> .... Use <tool> to build qmake [nmake] (Windows only) + -mp .................. Use multiple processors for compilation (MSVC only) + + -warnings-are-errors . Treat warnings as errors [no; yes if -developer-build] + -silent .............. Reduce the build output so that warnings and errors + can be seen more easily + +Build environment: + + -sysroot <dir> ....... Set <dir> as the target sysroot + -gcc-sysroot ......... With -sysroot, pass --sysroot to the compiler [yes] + + -pkg-config .......... Use pkg-config [auto] (Unix only) + + -D <string> .......... Pass additional preprocessor define + -I <string> .......... Pass additional include path + -L <string> .......... Pass additional library path + -F <string> .......... Pass additional framework path (Apple only) + + -sdk <sdk> ........... Build Qt using Apple provided SDK <sdk>. The argument + should be one of the available SDKs as listed by + 'xcodebuild -showsdks'. + Note that the argument applies only to Qt libraries + and applications built using the target mkspec - not + host tools such as qmake, moc, rcc, etc. + + -android-sdk path .... Set Android SDK root path [$ANDROID_SDK_ROOT] + -android-ndk path .... Set Android NDK root path [$ANDROID_NDK_ROOT] + -android-ndk-platform Set Android platform + -android-ndk-host .... Set Android NDK host (linux-x86, linux-x86_64, etc.) + [$ANDROID_NDK_HOST] + -android-arch ........ Set Android architecture (armeabi, armeabi-v7a, + arm64-v8a, x86, x86_64, mips, mips64) + -android-toolchain-version ... Set Android toolchain version + -android-style-assets Automatically extract style assets from the device at + run time. This option makes the Android style behave + correctly, but also makes the Android platform plugin + incompatible with the LGPL2.1. [yes] + +Component selection: + + -skip <repo> ......... Exclude an entire repository from the build. + -make <part> ......... Add <part> to the list of parts to be built. + Specifying this option clears the default list first. + [libs and examples, also tools if not cross-building, + also tests if -developer-build] + -nomake <part> ....... Exclude <part> from the list of parts to be built. + -compile-examples .... When unset, install only the sources of examples [yes] + -gui ................. Build the Qt GUI module and dependencies [yes] + -widgets ............. Build the Qt Widgets module and dependencies [yes] + -no-dbus ............. Do not build the Qt D-Bus module + [default on Android and Windows] + -dbus-linked ......... Build Qt D-Bus and link to libdbus-1 [auto] + -dbus-runtime ........ Build Qt D-Bus and dynamically load libdbus-1 [no] + DBUS_PATH= DBUS_HOST_PATH= + -feature-<feature> ... Enable <feature>. The available features are described + in src/corelib/global/qfeatures.txt. [all enabled] + -accessibility ....... Enable accessibility support [yes] + Note: Disabling accessibility is not recommended. + -qml-debug ........... Enable QML debugging support [yes] + +Qt comes with bundled copies of some 3rd party libraries. These are used +by default if auto-detection of the respective system library fails. + +Core options: + + -doubleconversion .... Select used double conversion library [system/qt/no] + No implies use of sscanf_l and snprintf_l (imprecise). + -glib ................ Enable Glib support [no; auto on Unix] + -eventfd ............. Enable eventfd support + -inotify ............. Enable inotify support + -iconv ............... Enable iconv(3) support [posix/sun/gnu/no] (Unix only) + -icu ................. Enable ICU support [auto] + -pps ................. Enable PPS support [auto] (QNX only) + -pcre ................ Select used libpcre3 [system/qt] + -zlib ................ Select used zlib [system/qt] + ZLIB_LIBS= + + Logging backends: + -journald .......... Enable journald support [no] (Unix only) + -syslog ............ Enable syslog support [no] (Unix only) + -slog2 ............. Enable slog2 support [auto] (QNX only) + +Network options: + + -ssl ................. Enable either SSL support method [auto] + -no-openssl .......... Do not use OpenSSL [default on Apple and WinRT] + -openssl-linked ...... Use OpenSSL and link to libssl [no] + -openssl-runtime ..... Use OpenSSL and dynamically load libssl [auto] + OPENSSL_PATH= OPENSSL_LIBS=, and on Windows also + OPENSSL_LIBS_DEBUG= OPENSSL_LIBS_RELEASE= + -securetransport ..... Use SecureTransport [auto] (Apple only) + + -sctp ................ Enable SCTP support [no] + + -libproxy ............ Enable use of libproxy [no] + -system-proxies ...... Use system network proxies by default [yes] + +Gui, printing, widget options: + + -cups ................ Enable CUPS support [auto] (Unix only) + + -fontconfig .......... Enable Fontconfig support [auto] (Unix only) + -freetype ............ Select used FreeType [system/qt/no] + -harfbuzz ............ Select used HarfBuzz-NG [system/qt/no] + (Not auto-detected on Apple and Windows) + + -gtk ................. Enable GTK platform theme support [auto] + + -lgmon ............... Enable lgmon support [auto] (QNX only) + + -no-opengl ........... Disable OpenGL support + -opengl <api> ........ Enable OpenGL support. Supported APIs: + es2 (default on Windows), desktop (default on Unix), + dynamic (Windows only) + -opengles3 ........... Enable OpenGL ES 3.x support instead of ES 2.x [auto] + -angle ............... Use bundled ANGLE to support OpenGL ES 2.0 [auto] + (Windows only) + + -qpa <name> .......... Select default QPA backend (e.g., xcb, cocoa, windows) + -xcb-xlib............. Enable Xcb-Xlib support [auto] + + Platform backends: + -direct2d .......... Enable Direct2D support [auto] (Windows only) + -directfb .......... Enable DirectFB support [no] (Unix only) + -eglfs ............. Enable EGLFS support [auto; no on Android and Windows] + -gbm ............... Enable backends for GBM [auto] (Linux only) + -kms ............... Enable backends for KMS [auto] (Linux only) + -linuxfb ........... Enable Linux Framebuffer support [auto] (Linux only) + -mirclient ......... Enable Mir client support [no] (Linux only) + -xcb ............... Select used xcb-* libraries [system/qt/no] + (-qt-xcb still uses system version of libxcb itself) + + Input backends: + -evdev ............. Enable evdev support [auto] + -imf ............... Enable IMF support [auto] (QNX only) + -libinput .......... Enable libinput support [auto] + -mtdev ............. Enable mtdev support [auto] + -tslib ............. Enable tslib support [auto] + -xinput2 ........... Enable XInput2 support [auto] + -xkbcommon-x11 ..... Select xkbcommon used in combination with xcb + [system/qt/no] + -xkb-config-root <dir> ... With -qt-xkbcommon-x11, set default XKB config + root <dir> [detect] + -xkbcommon-evdev ... Enable X-less xkbcommon in combination with libinput + [auto] + + Image formats: + -gif ............... Enable reading support for GIF [auto] + -ico ............... Enable support for ICO [yes] + -libpng ............ Select used libpng [system/qt/no] + -libjpeg ........... Select used libjpeg [system/qt/no] + +Database options: + + -sql-<driver> ........ Enable SQL <driver> plugin. Supported drivers: + db2 ibase mysql oci odbc psql sqlite2 sqlite tds + [all auto] + MYSQL_PATH= PSQL_LIBS= SYBASE= SYBASE_LIBS= + -sqlite .............. Select used sqlite3 [system/qt] |