qmake Variable Reference

DEPLOYMENT

This is only used on Windows CE and the Symbian platform.

Specifies which additional files will be deployed. Deployment means the transfer of files from the development system to the target device or emulator.

Files can be deployed by either creating a Visual Studio project or using the cetest executable.

For example:

 myFiles.sources = path\*.png
 DEPLOYMENT += myFiles

This will upload all PNG images in path to the same directory your build target will be deployed to.

The default deployment target path for Windows CE is %CSIDL_PROGRAM_FILES%\target, which usually gets expanded to \Program Files\target. For the Symbian platform, the default target is the application private directory on the drive it is installed to.

It is also possible to specify multiple sources to be deployed on target paths. In addition, different variables can be used for deployment to different directories.

For example:

 myFiles.sources = path\file1.ext1 path2\file2.ext1 path3\*
 myFiles.path = \some\path\on\device
 someother.sources = C:\additional\files\*
 someother.path = \myFiles\path2
 DEPLOYMENT += myFiles someother

Note: In Windows CE all linked Qt libraries will be deployed to the path specified by myFiles.path. On Symbian platform all libraries and executables will always be deployed to the \sys\bin of the installation drive.

Since the Symbian platform build system automatically moves binaries to certain directories under the epoc32 directory, custom plugins, executables or dynamically loadable libraries need special handling. When deploying extra executables or dynamically loadable libraries, the target path must specify \sys\bin. For plugins, the target path must specify the location where the plugin stub will be deployed to (see the How to Create Qt Plugins document for more information about plugins). If the binary cannot be found from the indicated source path, the directory Symbian build process moves the executables to is searched, e.g. \epoc32\release\armv5\urel.

For example:

 customplugin.sources = customimageplugin.dll
 customplugin.sources += c:\myplugins\othercustomimageplugin.dll
 customplugin.path = imageformats
 dynamiclibrary.sources = mylib.dll helper.exe
 dynamiclibrary.path = \sys\bin
 globalplugin.sources = someglobalimageplugin.dll
 globalplugin.path = \resource\qt\plugins\imageformats
 DEPLOYMENT += customplugin dynamiclibrary globalplugin

On the Symbian platform, generic PKG file content can also be specified with this variable. You can use either pkg_prerules or pkg_postrules to pass raw data to PKG file. The strings in pkg_prerules are added before package-body and pkg_postrules after. The strings defined in pkg_postrules or pkg_prerules are not parsed by qmake, so they should be in a format understood by Symbian package generation tools. Please consult the Symbian platform documentation for correct syntax.

For example, to deploy DLL and add a new dependency:

 somelib.sources = somelib.dll
 somelib.path = \sys\bin
 somelib.pkg_prerules = "(0x12345678), 2, 2, 0, {\"Some Package\"}" \
                   "(0x87654321), 1, *, * ~ 2, 2, 0, {\"Some Other Package\"}"
 justdep.pkg_prerules = "(0xAAAABBBB), 0, 2, 0, {\"My Framework\"}"
 DEPLOYMENT += somelib justdep

Please note that pkg_prerules can also replace default statements in pkg file. If no pkg_prerules is defined, qmake makes sure that PKG file syntax is correct and it contains all mandatory statements such as:

• languages, for example
  &EN,FR
• package-header, for example
  #{"MyApp-EN", "MyApp-FR"}, (0x1000001F), 1, 2, 3, TYPE=SA
• localized and unique vendor, for example
  %{"Vendor-EN", ..., "Vendor-FR"} :"Unique vendor name"

If you decide to override any of these statements, you need to pay attention that also other statements stay valid. For example if you override languages statement, you must override also package-header statement and all other statements which are language specific.

On the Symbian platform, the default_deployment item specifies default platform and package dependencies. Those dependencies can be selectively disabled if alternative dependencies need to be defined - e.g. if a specific device is required to run the application or more languages need to be supported by the package file. The supported default_deployment rules that can be disabled are:

• pkg_depends_qt
• pkg_depends_webkit
• pkg_platform_dependencies

For example:

 default_deployment.pkg_prerules -= pkg_platform_dependencies
 my_deployment.pkg_prerules = "[0x11223344],0,0,0,{\"SomeSpecificDeviceID\"}"
 DEPLOYMENT += my_deployment

On the Symbian platform, you can use DEPLOYMENT.installer_header variable to generate smart installer wrapper for your application. If you specify just UID of the installer package as the value, then installer package name and version will be autogenerated:

 DEPLOYMENT.installer_header = 0x12345678

If autogenerated values are not suitable, you can also specify the sis header yourself using this variable:

 DEPLOYMENT.installer_header = "$${LITERAL_HASH}{\"My Application Installer\"},(0x12345678),1,0,0"

 DEPLOYMENT_PLUGIN += qjpeg

 DESTDIR = ../../lib

 DISTFILES += ../program.txt

 FORMS = mydialog.ui \
     mywidget.ui \
         myconfig.ui

 FORMS3 = my_uic3_dialog.ui \
      my_uic3_widget.ui \
          my_uic3_config.ui

 HEADERS = myclass.h \
           login.h \
           mainwindow.h

 INCLUDEPATH = c:/msdev/include d:/stl/include

 win32:INCLUDEPATH += $$quote(C:/mylibs/extra headers)
 unix:INCLUDEPATH += $$quote(/home/user/extra headers)

 target.path += $$[QT_INSTALL_PLUGINS]/imageformats
 INSTALLS += target

 LEXSOURCES = lexer.l

 unix:LIBS += -L/usr/local/lib -lmath
 win32:LIBS += c:/mylibs/math.lib

 win32:LIBS += $$quote(C:/mylibs/extra libs/extra.lib)
 unix:LIBS += $$quote(-L/home/user/extra libs) -lextra

 CONFIG += no_lflags_merge

 # To include a literal hash character, use the $$LITERAL_HASH variable:
 urlPieces = http://qt.nokia.com/doc/4.0/qtextdocument.html pageCount
 message($$join(urlPieces, $$LITERAL_HASH))

 MMP_RULES += "DEFFILE hello.def"

 myBlock = \
 "START RESOURCE foo.rss" \
 "TARGET bar" \
 "TARGETPATH private\10001234" \
 "HEADER" \
 "LANG 01" \
 "UID 0x10002345 0x10003456" \
 "END"

 MMP_RULES += myBlock

 myIfdefBlock = \
 "$${LITERAL_HASH}ifdef WINSCW" \
 "DEFFILE hello_winscw.def" \
 "$${LITERAL_HASH}endif"

 MMP_RULES += myIfdefBlock

 # Set conditional libraries
 LIB.MARM = "LIBRARY myarm.lib"
 LIB.WINSCW = "LIBRARY mywinscw.lib"
 LIB.default = "LIBRARY mydefault.lib"

 # Add the conditional MMP rules
 MYCONDITIONS = MARM WINSCW
 MYVARIABLES = LIB

 addMMPRules(MYCONDITIONS, MYVARIABLES)

 unix:MOC_DIR = ../myproject/tmp
 win32:MOC_DIR = c:/myproject/tmp

 unix:OBJECTS_DIR = ../myproject/tmp
 win32:OBJECTS_DIR = c:/myproject/tmp

 app {
     # Conditional code for 'app' template here
 }

 FRAMEWORK_HEADERS.version = Versions
 FRAMEWORK_HEADERS.files = path/to/header_one.h path/to/header_two.h
 FRAMEWORK_HEADERS.path = Headers
 QMAKE_BUNDLE_DATA += FRAMEWORK_HEADERS

 QMAKE_BUNDLE_EXTENSION = .myframework

 QMAKE_CXXFLAGS.CW += -O2
 QMAKE_CXXFLAGS.ARMCC += -O0

 QMAKE_RESOURCE_FLAGS += -threshold 0 -compress 9

 QMAKE_UIC = uic -L /path/to/plugin

 QT -= gui # Only the core module is used.

 unix:RCC_DIR = ../myproject/resources
 win32:RCC_DIR = c:/myproject/resources

 RSS_RULES += "hidden = KAppIsHidden;"

 myrssrules = \
     "hidden = KAppIsHidden;" \
     "launch = KAppLaunchInBackground;" \
 RSS_RULES += myrssrules

 RSS_RULES.service_list += "uid = 0x12345678; datatype_list = \{\}; opaque_data = r_my_icon;"
 RSS_RULES.footer +="RESOURCE CAPTION_AND_ICON_INFO r_my_icon \{ icon_file =\"$$PWD/my_icon.svg\"; \}"

 SOURCES = myclass.cpp \
       login.cpp \
       mainwindow.cpp

 SUBDIRS = kernel \
           tools

 CONFIG += ordered

 SUBDIRS += my_executable my_library
 my_executable.subdir = app
 my_executable.depends = my_library
 my_library.subdir = lib

 symbian {
     SUBDIRS += emulator_dll
     emulator_dll.condition = WINSCW
 }

 TEMPLATE = app
 TARGET = myapp
 SOURCES = main.cpp

 TARGET.EPOCHEAPSIZE = 10000 10000000

 TARGET.EPOCSTACKSIZE = 0x8000

 TEMPLATE = lib
 SOURCES = main.cpp
 TARGET = mylib

 unix:UI_DIR = ../myproject/ui
 win32:UI_DIR = c:/myproject/ui

 unix:UI_HEADERS_DIR = ../myproject/ui/include
 win32:UI_HEADERS_DIR = c:/myproject/ui/include

 unix:UI_SOURCES_DIR = ../myproject/ui/src
 win32:UI_SOURCES_DIR = c:/myproject/ui/src

 VERSION = 1.2.3

 YACCSOURCES = moc.y

 message($$_PRO_FILE_)

 message($$_PRO_FILE_PWD_)