| 1 |
Usage: configure [options] [-- cmake-options] |
| 2 |
|
| 3 |
This is a convenience script for configuring Qt with CMake. |
| 4 |
Options after the double dash are directly passed to CMake. |
| 5 |
You can pass CMake variables as configure arguments: |
| 6 |
configure VAR=value |
| 7 |
which is equivalent to |
| 8 |
configure -- -DVAR=value |
| 9 |
|
| 10 |
Top-level installation directories: |
| 11 |
-prefix <dir> ...... The deployment directory, as seen on the target device. |
| 12 |
[/usr/local/Qt-$QT_VERSION; qtbase build directory if |
| 13 |
-developer-build] |
| 14 |
-no-prefix ......... The deployment directory is set to the qtbase build |
| 15 |
directory. Can be used instead of -developer-build |
| 16 |
to not have to install, as well as avoid |
| 17 |
-developer-build's default of -warnings-are-errors. |
| 18 |
-extprefix <dir> ... The installation directory, as seen on the host machine. |
| 19 |
[SYSROOT/PREFIX] |
| 20 |
|
| 21 |
Fine tuning of installation directory layout. Note that all directories |
| 22 |
except -sysconfdir should be located under -prefix: |
| 23 |
|
| 24 |
-bindir <dir> ......... Executables [PREFIX/bin] |
| 25 |
-headerdir <dir> ...... Header files [PREFIX/include] |
| 26 |
-libdir <dir> ......... Libraries [PREFIX/lib] |
| 27 |
-archdatadir <dir> .... Arch-dependent data [PREFIX] |
| 28 |
-plugindir <dir> ...... Plugins [ARCHDATADIR/plugins] |
| 29 |
-libexecdir <dir> ..... Helper programs [ARCHDATADIR/bin on Windows, |
| 30 |
ARCHDATADIR/libexec otherwise] |
| 31 |
-qmldir <dir> ......... QML imports [ARCHDATADIR/qml] |
| 32 |
-sbomdir <dir> ....... Software Bill of Materials (SBOM) |
| 33 |
installation directory [ARCHDATADIR/sbom] |
| 34 |
-datadir <dir> ........ Arch-independent data [PREFIX] |
| 35 |
-docdir <dir> ......... Documentation [DATADIR/doc] |
| 36 |
-translationdir <dir> . Translations [DATADIR/translations] |
| 37 |
-sysconfdir <dir> ..... Settings used by Qt programs [PREFIX/etc/xdg] |
| 38 |
-examplesdir <dir> .... Examples [PREFIX/examples] |
| 39 |
-testsdir <dir> ....... Tests [PREFIX/tests] |
| 40 |
-hostdatadir <dir> .... Data used by qmake [PREFIX] |
| 41 |
|
| 42 |
Conventions for the remaining options: When an option's description is |
| 43 |
followed by a list of values in brackets, the interpretation is as follows: |
| 44 |
'yes' represents the bare option; all other values are possible prefixes to |
| 45 |
the option, e.g., -no-gui. Alternatively, the value can be assigned, e.g., |
| 46 |
--gui=yes. Values are listed in the order they are tried if not specified; |
| 47 |
'auto' is a shorthand for 'yes/no'. Solitary 'yes' and 'no' represent binary |
| 48 |
options without auto-detection. |
| 49 |
|
| 50 |
Configure meta: |
| 51 |
|
| 52 |
-help, -h ............ Display this help screen |
| 53 |
-redo ................ Re-configure with previously used options. In addition, |
| 54 |
redo removes CMakeCache.txt file and CMakeFiles/ directory |
| 55 |
and recreates them from scratch. |
| 56 |
Additional options may be passed, but will not be |
| 57 |
saved for later use by -redo. |
| 58 |
|
| 59 |
-feature-<feature> ... Enable <feature> |
| 60 |
-no-feature-<feature> Disable <feature> [none] |
| 61 |
-list-features ....... List available features. Note that some features |
| 62 |
have dedicated command line options as well. |
| 63 |
|
| 64 |
Build options: |
| 65 |
|
| 66 |
-cmake-generator <name> ... Explicitly specify the build system generator for |
| 67 |
CMake instead of auto-detecting one. |
| 68 |
-cmake-use-default-generator ... Turn off auto-detection of the CMake build |
| 69 |
system generator. |
| 70 |
-cmake-file-api ...... Let CMake store build metadata for loading the build |
| 71 |
into an IDE. [no; yes if -developer-build] |
| 72 |
-dry-run ............. Only print the CMake command but don't execute it. |
| 73 |
-no-guess-compiler ... Do not guess the compiler from the target mkspec. |
| 74 |
-release ............. Build Qt with optimizations and without debug |
| 75 |
symbols [yes] |
| 76 |
Note that -developer-build implies -debug unless |
| 77 |
-release is also explicitly specified |
| 78 |
-debug ............... Build Qt without optimizations and with debug symbols |
| 79 |
[no] |
| 80 |
-debug-and-release ... Build two versions of Qt in one build tree [no] |
| 81 |
-optimize-debug ...... Enable debug-friendly optimizations in debug builds |
| 82 |
[auto] (Not supported with MSVC or Clang toolchains) |
| 83 |
-optimize-size ....... Optimize release builds for size instead of speed [no] |
| 84 |
-force-debug-info .... Create symbol files for release builds [no] |
| 85 |
-separate-debug-info . Split off debug information to separate files [no] |
| 86 |
-gdb-index ........... Index the debug info to speed up GDB |
| 87 |
[no; auto if -developer-build with debug info] |
| 88 |
-gc-binaries ......... Place each function or data item into its own section |
| 89 |
and enable linker garbage collection of unused |
| 90 |
sections. [auto for static builds, otherwise no] |
| 91 |
-force-asserts ....... Enable Q_ASSERT even in release builds [no] |
| 92 |
-developer-build ..... Compile and link Qt for developing Qt itself |
| 93 |
(exports for auto-tests, extra checks, implies |
| 94 |
-no-prefix, etc.) [no] |
| 95 |
|
| 96 |
-shared .............. Build shared Qt libraries [yes] (no for UIKit) |
| 97 |
-static .............. Build static Qt libraries [no] (yes for UIKit) |
| 98 |
-framework ........... Build Qt framework bundles [yes] (Apple only) |
| 99 |
|
| 100 |
-platform <target> ... Select mkspec for the qmake companion files |
| 101 |
-device <name> ....... Select devices/mkspec for the qmake companion files |
| 102 |
-device-option <key=value> ... Add option for the device mkspec |
| 103 |
|
| 104 |
-appstore-compliant .. Disable code that is not allowed in platform app stores. |
| 105 |
This is on by default for platforms which require distribution |
| 106 |
through an app store by default, in particular Android, |
| 107 |
iOS, tvOS, and watchOS. [auto] |
| 108 |
|
| 109 |
-sbom ................ Enable generation of Software Bill of Materials (SBOM) |
| 110 |
documents in SPDX tag:value format |
| 111 |
[yes; no for developer builds] |
| 112 |
-sbom-json ........... Enable SBOM generation in SPDX JSON format [auto] |
| 113 |
(if Python dependencies are available) |
| 114 |
-sbom-json-required .. Fails the build if the Python dependencies for JSON |
| 115 |
generation are not found [no] |
| 116 |
-sbom-verify ......... Verify generated SBOM files [auto] (if Python |
| 117 |
dependencies are available) |
| 118 |
-sbom-verify-required Fails the build if the Python dependencies for SBOM |
| 119 |
verification are not found [no] |
| 120 |
|
| 121 |
|
| 122 |
-qt-host-path <path> . Specify path to a Qt host build for cross-compiling. |
| 123 |
-qtnamespace <name> .. Wrap all Qt library code in 'namespace <name> {...}'. |
| 124 |
-qtinlinenamespace ... Make -qtnamespace an inline namespace |
| 125 |
-qtlibinfix <infix> .. Rename all libQt6*.so to libQt6*<infix>.so. |
| 126 |
|
| 127 |
-coverage <tool> ..... Instrument with the code coverage tool. |
| 128 |
-gcov ................ Instrument with the GCov code coverage tool [no] |
| 129 |
|
| 130 |
-trace [backend] ..... Enable instrumentation with tracepoints. |
| 131 |
Currently supported backends are 'etw' (Windows), |
| 132 |
'lttng' (Linux), 'ctf' (Common Trace Format, cross-platform) |
| 133 |
or 'yes' for auto-detection. [no] |
| 134 |
|
| 135 |
-sanitize {address|thread|memory|fuzzer-no-link|undefined} |
| 136 |
Instrument with the specified compiler sanitizer. |
| 137 |
Note that some sanitizers cannot be combined; |
| 138 |
for example, -sanitize address cannot be combined with |
| 139 |
-sanitize thread. |
| 140 |
|
| 141 |
-mips_dsp/-mips_dspr2 Use MIPS DSP/rev2 instructions [auto] |
| 142 |
|
| 143 |
-qreal <type> ........ typedef qreal to the specified type. [double] |
| 144 |
Note: this affects binary compatibility. |
| 145 |
|
| 146 |
-R <string> .......... Add an explicit runtime library path to the Qt |
| 147 |
libraries. Supports paths relative to LIBDIR. |
| 148 |
-rpath ............... Link Qt libraries and executables using the library |
| 149 |
install path as a runtime library path. Similar to |
| 150 |
-R LIBDIR. On Apple platforms, disabling this implies |
| 151 |
using absolute install names (based in LIBDIR) for |
| 152 |
dynamic libraries and frameworks. [auto] |
| 153 |
|
| 154 |
-reduce-exports ...... Reduce amount of exported symbols [auto] |
| 155 |
-reduce-relocations .. Reduce amount of relocations [auto] (Unix only) |
| 156 |
|
| 157 |
-plugin-manifests .... Embed manifests into plugins [no] (Windows only) |
| 158 |
-static-runtime ...... With -static, use static runtime [no] (Windows only) |
| 159 |
|
| 160 |
-pch ................. Use precompiled headers [auto] |
| 161 |
-ltcg ................ Use Link Time Code Generation [no] |
| 162 |
-intelcet ............ Use Intel Control-flow Enforcement Technology [auto] |
| 163 |
-glibc-fortify-source Use Glibc function fortification [auto] |
| 164 |
-trivial-auto-var-init-pattern |
| 165 |
Use -ftrivial-auto-var-init=pattern [auto] |
| 166 |
-stack-protector ..... Use -fstack-protector-strong [auto] |
| 167 |
-stack-clash-protection |
| 168 |
Use -fstack-clash-protection [auto] |
| 169 |
-libstdcpp-assertions Use libstdc++ assertions [auto] |
| 170 |
-libcpp-hardening .... Use libc++ hardening [auto] |
| 171 |
-relro-now-linker .... Use -z relro -z now when linking [auto] |
| 172 |
-linker [bfd,gold,lld,mold] |
| 173 |
Force use of the GNU ld, GNU gold, LLVM/LLD or mold |
| 174 |
linker instead of default one (GCC and clang only) |
| 175 |
-ccache .............. Use the ccache compiler cache [no] (Unix only) |
| 176 |
-unity-build ......... Enable Unity (Jumbo) build |
| 177 |
-unity-build-batch-size <int> |
| 178 |
Maximum number of source files used by the unity build |
| 179 |
to create unity source files [32] |
| 180 |
|
| 181 |
-warnings-are-errors . Treat warnings as errors [no; yes if -developer-build] |
| 182 |
|
| 183 |
-disable-deprecated-up-to <version> |
| 184 |
Set the QT_DISABLE_DEPRECATED_UP_TO value to <version>. |
| 185 |
QT_DISABLE_DEPRECATED_UP_TO is used to remove |
| 186 |
deprecated methods from both API and ABI. |
| 187 |
<version> is a hex value, for example 0x060500 can be |
| 188 |
used to remove all code deprecated in Qt 6.5.0 or |
| 189 |
earlier releases. |
| 190 |
By default <version> is set to 0x040000 and 0x050000 on |
| 191 |
Windows, and non-Windows respectively. |
| 192 |
|
| 193 |
Build environment: |
| 194 |
|
| 195 |
-pkg-config .......... Use pkg-config [auto] (Unix only) |
| 196 |
|
| 197 |
-vcpkg ............... Use vcpkg for downloading and finding 3rd-party |
| 198 |
dependencies [no] |
| 199 |
-generate-vcpkg-manifest ... Generate a vcpkg.json file in the build directory |
| 200 |
[no; yes if -vcpkg] |
| 201 |
|
| 202 |
-D <string> .......... Pass additional preprocessor define |
| 203 |
-I <string> .......... Pass additional include path |
| 204 |
-L <string> .......... Pass additional library path |
| 205 |
-F <string> .......... Pass additional framework path (Apple only) |
| 206 |
|
| 207 |
-sdk <sdk> ........... Build Qt using Apple provided SDK <sdk>. The argument |
| 208 |
should be one of the available SDKs as listed by |
| 209 |
'xcodebuild -showsdks'. |
| 210 |
|
| 211 |
-android-sdk path .... Set Android SDK root path [$ANDROID_SDK_ROOT] |
| 212 |
-android-ndk path .... Set Android NDK root path [$ANDROID_NDK_ROOT] |
| 213 |
-android-ndk-platform Set Android platform |
| 214 |
-android-abis ....... Only one ABI can be specified, default is: armeabi-v7a |
| 215 |
-android-javac-target Set the javac build target version [8] |
| 216 |
-android-javac-source Set the javac build source version [8] |
| 217 |
-android-style-assets Automatically extract style assets from the device at |
| 218 |
run time. This option makes the Android style behave |
| 219 |
correctly, but also makes the Android platform plugin |
| 220 |
incompatible with the LGPL2.1. [yes] |
| 221 |
|
| 222 |
Component selection: |
| 223 |
|
| 224 |
-submodules <repo>[,<repo>] ... Build the listed repositories and those they |
| 225 |
depend on rather than all checked-out repositories. |
| 226 |
The list should be separated with commas, e.g. |
| 227 |
-submodules qtsvg,qtnetworkauth |
| 228 |
[default is to build all checked out repositories] |
| 229 |
-skip <repo>[,<repo>] Exclude one or more entire repositories from the |
| 230 |
build. The list should be separated with commas. |
| 231 |
e.g. -skip qtimageformats,qtsvg |
| 232 |
-skip-tests <repo>[,<repo>] ... Skip building tests for one or more |
| 233 |
repositories. The list should be separated with commas. |
| 234 |
e.g. -skip-tests qtimageformats,qtsvg |
| 235 |
-skip-examples <repo>[,<repo>] ... Skip building examples for one or more |
| 236 |
repositories. The list should be separated with commas. |
| 237 |
e.g. -skip-examples qtimageformats,qtsvg |
| 238 |
-init-submodules ..... When configure is called from the qt git super module, |
| 239 |
it will automatically clone and initialize the |
| 240 |
repositories specified by the -submodules option. When |
| 241 |
no -submodules are specified, and no existing |
| 242 |
submodules are cloned, a default set of submodules |
| 243 |
will be initialized. To adjust other aspects of the |
| 244 |
cloning process, check the init-repository --help |
| 245 |
output for additional options that can be passed |
| 246 |
to configure. |
| 247 |
-make <part> ......... Add <part> to the list of parts to be built. |
| 248 |
Specifying this option clears the default list first. |
| 249 |
(allowed values: examples, tests, |
| 250 |
benchmarks, manual-tests, minimal-static-tests, |
| 251 |
doc-snippets) |
| 252 |
[default: tests and doc-snippets if -developer-build] |
| 253 |
-nomake <part> ....... Exclude <part> from the list of parts to be built. |
| 254 |
-install-examples-sources Installs examples source code into the Qt prefix |
| 255 |
Only possible when -make examples is also passed |
| 256 |
[no] |
| 257 |
-gui ................. Build the Qt GUI module and dependencies [yes] |
| 258 |
-widgets ............. Build the Qt Widgets module and dependencies [yes] |
| 259 |
-no-dbus ............. Do not build the Qt D-Bus module |
| 260 |
[default on Android and Windows] |
| 261 |
-dbus-linked ......... Build Qt D-Bus and link to libdbus-1 [auto] |
| 262 |
-dbus-runtime ........ Build Qt D-Bus and dynamically load libdbus-1 [no] |
| 263 |
-accessibility ....... Enable accessibility support [yes] |
| 264 |
Note: Disabling accessibility is not recommended. |
| 265 |
|
| 266 |
Qt comes with bundled copies of some 3rd party libraries. These are used |
| 267 |
by default if auto-detection of the respective system library fails. |
| 268 |
|
| 269 |
-force-bundled-libs .. Only use bundled 3rd party libraries [no] |
| 270 |
-force-system-libs ... Do not use bundled 3rd party libraries [no] |
| 271 |
|
| 272 |
Core options: |
| 273 |
|
| 274 |
-doubleconversion .... Select used double conversion library [system/qt/no] |
| 275 |
No implies use of sscanf_l and snprintf_l (imprecise). |
| 276 |
-glib ................ Enable Glib support [no; auto on Unix] |
| 277 |
-inotify ............. Enable inotify support |
| 278 |
-icu ................. Enable ICU support [auto] |
| 279 |
-jemalloc ............ Enable jemalloc support and cooperation [no] |
| 280 |
-pcre ................ Select used libpcre2 [system/qt] |
| 281 |
-zlib ................ Select used zlib [system/qt] |
| 282 |
|
| 283 |
Logging backends: |
| 284 |
-journald .......... Enable journald support [no] (Unix only) |
| 285 |
-syslog ............ Enable syslog support [no] (Unix only) |
| 286 |
-slog2 ............. Enable slog2 support [auto] (QNX only) |
| 287 |
|
| 288 |
Network options: |
| 289 |
|
| 290 |
-ssl ................. Enable either SSL support method [auto] |
| 291 |
-no-openssl .......... Do not use OpenSSL [default on Apple] |
| 292 |
-openssl-linked ...... Use OpenSSL and link to libssl [no] |
| 293 |
-openssl-runtime ..... Use OpenSSL and dynamically load libssl [auto] |
| 294 |
-schannel ............ Use Secure Channel [auto] (Windows only) |
| 295 |
-securetransport ..... Use SecureTransport [auto] (Apple only) |
| 296 |
|
| 297 |
-sctp ................ Enable SCTP support [no] |
| 298 |
|
| 299 |
-libproxy ............ Enable use of libproxy [no] |
| 300 |
-system-proxies ...... Use system network proxies by default [yes] |
| 301 |
|
| 302 |
Gui, printing, widget options: |
| 303 |
|
| 304 |
-cups ................ Enable CUPS support [auto] (Unix only) |
| 305 |
|
| 306 |
-emojisegmenter ...... Enable complex emoji sequences [yes] |
| 307 |
-fontconfig .......... Enable Fontconfig support [auto] (Unix only) |
| 308 |
-freetype ............ Select used FreeType [system/qt/no] |
| 309 |
-harfbuzz ............ Select used HarfBuzz-NG [system/qt/no] |
| 310 |
(Not auto-detected on Apple and Windows) |
| 311 |
|
| 312 |
-gtk ................. Enable GTK platform theme support [auto] |
| 313 |
|
| 314 |
-no-opengl ........... Disable OpenGL support |
| 315 |
-opengl <api> ........ Enable OpenGL support. Supported APIs: |
| 316 |
es2, desktop (default on Unix), |
| 317 |
dynamic (Windows only, default on Windows) |
| 318 |
-opengles3 ........... Enable OpenGL ES 3.x support instead of ES 2.x [auto] |
| 319 |
-egl ................. Enable EGL support [auto] |
| 320 |
|
| 321 |
-qpa <qpa1>[;<qpa2>] . Select supported QPA backend(s) (e.g., xcb, cocoa, |
| 322 |
windows). A list separated by semi-colons. |
| 323 |
-default-qpa <name> .. Select the default QPA backend (e.g., xcb, cocoa, |
| 324 |
windows). |
| 325 |
-xcb-xlib............. Enable Xcb-Xlib support [auto] |
| 326 |
|
| 327 |
Platform backends: |
| 328 |
-direct2d .......... Enable Direct2D support [auto] (Windows only) |
| 329 |
-directfb .......... Enable DirectFB support [no] (Unix only) |
| 330 |
-eglfs ............. Enable EGLFS support [auto; no on Android and Windows] |
| 331 |
-gbm ............... Enable backends for GBM [auto] (Linux only) |
| 332 |
-kms ............... Enable backends for KMS [auto] (Linux only) |
| 333 |
-linuxfb ........... Enable Linux Framebuffer support [auto] (Linux only) |
| 334 |
-xcb ............... Enable X11 support [auto] (Linux only) |
| 335 |
|
| 336 |
Input backends: |
| 337 |
-libudev............ Enable udev support [auto] |
| 338 |
-evdev ............. Enable evdev support [auto] |
| 339 |
-libinput .......... Enable libinput support [auto] |
| 340 |
-mtdev ............. Enable mtdev support [auto] |
| 341 |
-tslib ............. Enable tslib support [auto] |
| 342 |
-bundled-xcb-xinput Use bundled XInput2 support [auto] |
| 343 |
-xkbcommon ......... Enable key mapping support [auto] |
| 344 |
|
| 345 |
Image formats: |
| 346 |
-gif ............... Enable reading support for GIF [auto] |
| 347 |
-ico ............... Enable support for ICO [yes] |
| 348 |
-libpng ............ Select used libpng [system/qt/no] |
| 349 |
-libjpeg ........... Select used libjpeg [system/qt/no] |
| 350 |
|
| 351 |
Database options: |
| 352 |
|
| 353 |
-sql-<driver> ........ Enable SQL <driver> plugin. Supported drivers: |
| 354 |
db2 ibase mysql oci odbc psql sqlite mimer |
| 355 |
[all auto] |
| 356 |
-sqlite .............. Select used sqlite [system/qt] |