Module wix

The wix module contains properties and rules for building MSI and EXE setup packages with the Windows Installer XML Toolset.

This module is available on all platforms.

General Properties

PropertyTypeSinceDefaultDescription
debugInformationbool1.2qbs.debugInformationGenerate debug information. See qbs.debugInformation.
definesstringList1.2undefinedList of preprocessor macros that get passed to the compiler. To set macro values use the following syntax: wix.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"']
enableQbsDefinesbool1.2trueWhether to define preprocessor macros corresponding to values from the project and product objects. When building a 64-bit package, the preprocessor variable Win64 will also be defined.
visualStudioCompatibilitybool1.2truePasses most of the same preprocessor macros to the compiler as Visual Studio does. This allows easier authoring WiX files that are compatible with both Qbs and MSBuild.
includePathspathList1.2undefinedList of include paths. Relative paths are considered to be relative to the .qbs product file they are used in.
treatWarningsAsErrorsbool1.2falseWarnings will be handled as errors and cause the build to fail.
warningLevelstring1.2"normal"Severity of warnings to emit. The higher the level, the more warnings will be shown. Possible values include: "none", "normal", "pedantic"
verboseOutputbool1.2falseWhether to display verbose output from the compiler and linker.
compilerFlagsstringList1.2undefinedAdditional flags for the Candle compiler.
linkerFlagsstringList1.2undefinedAdditional flags for the Light linker.
culturesstringList1.2undefinedList of localizations to include in the MSI. Use undefined to include all localizations.
extensionsstringList1.2["WixBalExtension"] if the product type is an EXE setup application, otherwise undefined.List of extension assemblies to link into the output. Possible values include: "WixBalExtension", "WixComPlusExtension", "WixDependencyExtension", "WixDifxAppExtension", "WixDirectXExtension", "WixFirewallExtension", "WixGamingExtension", "WixIisExtension", "WixMsmqExtension", "WixNetFxExtension", "WixPSExtension", "WixSqlExtension", "WixTagExtension", "WixUIExtension", "WixUtilExtension", "WixVSExtension", custom assemblies
versionstring1.2undefinedThe WiX version. Consists of four numbers separated by dots, for instance "3.7.1224.0".
versionMajorint1.2versionParts[0]The WiX major version.
versionMinorint1.2versionParts[1]The WiX minor version.
versionPartslist1.2emptyThe WiX version as a list. For instance, WiX version 3.7.1224.0 would correspond to a value of [3, 7, 1224, 0].
versionPatchint1.2versionParts[2]The WiX patch level.
versionBuildint1.2versionParts[3]The fourth WiX version number component.
toolchainInstallPathpath1.2determined automaticallyWiX installation directory. Determined by searching the registry for the latest version. This should not normally need to be changed.
toolchainInstallRootpath1.2determined automaticallyWiX binaries directory. Determined by searching the registry for the latest version. This should not normally need to be changed.
compilerNamestring1.2"candle.exe"Name of the compiler binary. This should not normally need to be changed.
compilerPathstring1.2compilerNameDirectory where the compiler binary is located. This should not normally need to be changed.
linkerNamestring1.2"light.exe"Name of the linker binary. This should not normally need to be changed.
linkerPathstring1.2linkerNameDirectory where the linker binary is located. This should not normally need to be changed.

© 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.