Using Qmake
Using Qmake
Using Qmake
qmake provides a project-oriented system for managing the build process for applications,
libraries, and other components. This approach gives developers control over the source
files used, and allows each of the steps in the process to be described concisely, typically
within a single file.qmake expands the information in each project file to a Makefile that
executes the necessary commands for compiling and linking.
In this document, we provide a basic introduction to project files, describe some of the main
features of qmake, and show how to use qmake on the command line.
Describing a Project
Projects are described by the contents of project (.pro) files. The information within these
is used by qmake to generate a Makefile containing all the commands that are needed to
build each project. Project files typically contain a list of source and header files, general
configuration information, and any application-specific details, such as a list of extra
libraries to link against, or a list of extra include paths to use.
Project files can contain a number of different elements, including comments, variable
declarations, built-in functions, and some simple control structures. In most simple projects,
it is only necessary to declare the source and header files that are used to build the project
with some basic configuration options.
Complete examples of project files can be found in the qmake Tutorial. An introduction to
project files can be found in the qmake Project Files chapter, and a more detailed
description is available in the qmake Reference.
Building a Project
For simple projects, you only need to run qmake in the top level directory of your project. By
default, qmake generates a Makefile that you then use to build the project, and you can then
run your platform's make tool to build the project.
qmake can also be used to generate project files. A full description of qmake's command line
options can be found in the Running qmake chapter of this manual.
Variables
In a project file, variables are used to hold lists of strings. In the simplest projects, these
variables inform qmake about the configuration options to use, or supply filenames and
paths to use in the build process.
qmake looks for certain variables in each project file, and it uses the contents of these to
determine what it should write to a Makefile. For example, the list of values in
the HEADERSand SOURCES variables are used to tell qmake about header and source files in
the same directory as the project file.
Variables can also be used internally to store temporary lists of values, and existing lists of
values can be overwritten or extended with new values.
The following lines show how lists of values are assigned to variables:
Note that the first assignment only includes values that are specified on the same line as
the SOURCES variable. The second assignment splits the items across lines by using
the \\character.
The list of values in a variable is extended in the following way:
paintwidget.cpp
CONFIG += qt
DESTDIR The directory in which the executable or binary file will be placed.
HEADERS A list of filenames of header (.h) files used when building the project.
Variable Contents
RESOURCES A list of resource (.rc) files to be included in the final project. See the The Qt Resource System for more
information about these files.
SOURCES A list of source code files to be used when building the project.
TEMPLATE The template to use for the project. This determines whether the output of the build process will be an application,
a library, or a plugin.
The contents of a variable can be read by prepending the variable name with $$. This can
be used to assign the contents of one variable to another:
TEMP_SOURCES = $$SOURCES
The $$ operator is used extensively with built-in functions that operate on strings and lists
of values. These are described in the chapter on qmake Advanced Usage.
Whitespace
Normally, variables are used to contain whitespace-separated lists of values. However, it is
sometimes necessary to specify values containing spaces. These must be quoted by using
the quote() function in the following way:
The quoted text is treated as a single item in the list of values held by the variable. A similar
approach is used to deal with paths that contain spaces, particularly when defining
theINCLUDEPATH and LIBS variables for the Windows platform. In cases like these,
the quote()function can be used in the following way:
Comments
You can add comments to project files. Comments begin with the # character and continue
to the end of the same line. For example:
include(other.pro)
win32 {
SOURCES += paintwidget_win.cpp
The assignments inside the braces are only made if the condition is true. In this case, the
special win32 variable must be set; this happens automatically on Windows, but this can
also be specified on other platforms by running qmake with the -win32 command line option
(see Running qmake for more information). The opening brace must stand on the same line
as the condition.
Simple loops are constructed by iterating over lists of values using the built-in for function.
The following code adds directories to the SUBDIRS variable, but only if they exist:
for(dir, EXTRAS) {
exists($$dir) {
SUBDIRS += $$dir
More complex operations on variables that would usually require loops are provided by
built-in functions such as find, unique, and count. These functions, and many others are
provided to manipulate strings and paths, support user input, and call external tools. A list
of the functions available can be found in the qmake Advanced Usage chapter of this
manual.
Project Templates
The TEMPLATE variable is used to define the type of project that will be built. If this is not
declared in the project file, qmake assumes that an application should be built, and will
generate an appropriate Makefile (or equivalent file) for the purpose.
The types of project available are listed in the following table with information about the
files that qmake will generate for each of them:
Template Description of qmake output
subdirs Creates a Makefile containing rules for the subdirectories specified using the SUBDIRS variable. Each subdirectory
must contain its own project file.
See the qmake Tutorial for advice on writing project files for projects that use
the app andlib templates.
When the subdirs template is used, qmake generates a Makefile to examine each specified
subdirectory, process any project file it finds there, and run the platform's make tool on the
newly-created Makefile. The SUBDIRS variable is used to contain a list of all the
subdirectories to be processed.
General Configuration
The CONFIG variable specifies the options and features that the compiler should use and the
libraries that should be linked against. Anything can be added to the CONFIG variable, but
the options covered below are recognized by qmake internally.
The following options control the compiler flags that are used to build the project:
Option Description
release The project is to be built in release mode. This is ignored if debug is also specified.
debug_and_release_target The project is built in both debug and release modes. TARGET is built into both the debug and
release directories.
build_all If debug_and_release is specified, the project is built in both debug and release modes by
default.
autogen_precompile_source Automatically generates a .cpp file that includes the precompiled header file specified in the .pro
file.
ordered When using the subdirs template, this option specifies that the directories listed should be
Option Description
warn_on The compiler should output as many warnings as possible. This is ignored if warn_off is
specified.
copy_dir_files Enables the install rule to also copy directories, not just files.
The debug_and_release option is special in that it enables both debug and release versions
of a project to be built. In such a case, the Makefile that qmake generates includes a rule
that builds both versions, and this can be invoked in the following way:
make all
CONFIG(opengl) {
} else {
qt The project is a Qt application and should link against the Qt library. You can use the QT variable to control any
additional Qt modules that are required by your application.
Note, that you must use "+=", not "=", or qmake will not be able to use Qt's configuration to
determine the settings needed for your project.
Declaring Qt Libraries
If the CONFIG variable contains the qt value, qmake's support for Qt applications is enabled.
This makes it possible to fine-tune which of the Qt modules are used by your application.
This is achieved with the QT variable which can be used to declare the required extension
modules. For example, we can enable the XML and network modules in the following way:
CONFIG += qt
QT += network xml
QT = network xml # This will omit the core and gui modules.
If you want to build a project without the gui module, you need to exclude it with the "-="
operator. By default, QT contains both core and gui, so the following line will result in a
minimal Qt project being built:
The table below shows the options that can be used with the QT variable and the features
that are associated with each of them:
Option Features
network QtNetwork module
opengl QtOpenGL module
sql QtSql module
svg QtSvg module
xml QtXml module
xmlpatterns QtXmlPatterns module
qt3support Qt3Support module
Note that adding the opengl option to the QT variable automatically causes the equivalent
option to be added to the CONFIG variable. Therefore, for Qt applications, it is not necessary
to add the opengl option to both CONFIG and QT.
Configuration Features
qmake can be set up with extra configuration features that are specified in feature (.prf)
files. These extra features often provide support for custom tools that are used during the
build process. To add a feature to the build process, append the feature name (the stem of
the feature filename) to the CONFIG variable.
For example, qmake can configure the build process to take advantage of external libraries
that are supported by pkg-config, such as the D-Bus and ogg libraries, with the following
lines:
CONFIG += link_pkgconfig
The paths containing header files can also be specified in a similar way using
theINCLUDEPATH variable.
For example, it is possible to add several paths to be searched for header files:
Running qmake
The behavior of qmake can be customized when it is run by specifying various options on the
command line. These allow the build process to be fine-tuned, provide useful diagnostic
information, and can be used to specify the target platform for your project.
Command-Line Options
Syntax
The syntax used to run qmake takes the following simple form:
qmake supports two different modes of operation: In the default mode, qmake will use the
description in a project file to generate a Makefile, but it is also possible to use qmake to
generate project files. If you want to explicitly set the mode, you must specify it before all
other options. The mode can be either of the following two values:
-makefile
qmake output will be a Makefile.
-project
qmake output will be a project file.
Note: It is likely that the created file will need to be edited for example adding
the QTvariable to suit what modules are required for the project.
The following options are used to specify both general and mode-specific settings. Options
that only apply to the Makefile mode are described in the Makefile Mode Options section;
options that influence the creation of project files are described in the Project File
Optionssection.
The files argument represents a list of one or more project files, separated by spaces.
Options
A wide range of options can be specified on the command line to qmake in order to
customize the build process, and to override default settings for your platform. The
following basic options provide usage information, specify where qmake writes the output
file, and control the level of debugging information that will be written to the console:
-help
qmake will go over these features and give some useful help.
-o file
qmake output will be directed to file. If this option is not specified, qmake will try to use a
suitable file name for its output, depending on the mode it is running in.
If '-' is specified, output is directed to stdout.
-d
qmake will output debugging information.
For projects that need to be built differently on each target platform, with many
subdirectories, you can run qmake with each of the following options to set the
corresponding platform-specific variable in each project file:
-unix
qmake will run in unix mode. In this mode, Unix file naming and path conventions will be
used, additionally testing for unix (as a scope) will succeed. This is the default mode on all
Unices.
-macx
qmake will run in Mac OS X mode. In this mode, Unix file naming and path conventions will
be used, additionally testing for macx (as a scope) will succeed. This is the default mode on
Mac OS X.
-win32
qmake will run in win32 mode. In this mode, Windows file naming and path conventions will
be used, additionally testing for win32 (as a scope) will succeed. This is the default mode on
Windows.
The template used for the project is usually specified by the TEMPLATE variable in the
project file. We can override or modify this by using the following options:
-t tmpl
qmake will override any set TEMPLATE variables with tmpl, but only after the .pro file has
been processed.
-tp prefix
qmake will add the prefix to the TEMPLATE variable.
The level of warning information can be fine-tuned to help you find problems in your project
file:
-Wall
qmake will report all known warnings.
-Wnone
No warning information will be generated by qmake.
-Wparser
qmake will only generate parser warnings. This will alert you to common pitfalls and
potential problems in the parsing of your project files.
-Wlogic
qmake will warn of common pitfalls and potential problems in your project file. For
example, qmake will report whether a file is placed into a list of files multiple times, or if a
file cannot be found.
-nocache
qmake will ignore the .qmake.cache file.
-nodepend
qmake will not generate any dependency information.
-cache file
qmake will use file as the cache file, ignoring any other .qmake.cache files found.
-spec spec
qmake will use spec as a path to platform and compiler information, and the value
ofQMAKESPEC will be ignored.
You may also pass qmake assignments on the command line; they will be processed before
all of the files specified. For example:
This will generate a Makefile, from test.pro with Unix pathnames. However many of the
specified options aren't necessary as they are the default. Therefore, the line can be
simplified on Unix to:
If you are certain you want your variables processed after the files specified, then you may
pass the -after option. When this is specified, all assignments on the command line after
the -after option will be postponed until after the specified files are parsed.
Project Mode Options
In project mode, qmake will generate a project file. Additionally, you may supply the
following options in this mode:
-r
qmake will look through supplied directories recursively
-nopwd
qmake will not look in your current working directory for source code and only use the
specified files
Mac OS X
Features specific to this platform include support for creating universal binaries, frameworks
and bundles.
QMAKE_LFLAGS += -F/path/to/framework/directory/
The framework itself is linked in by appending the -framework options and the name of the
framework to the LIBS variable:
Creating Frameworks
Any given library project can be configured so that the resulting library file is placed in
aframework, ready for deployment. To do this, set up the project to use
the lib templateand add the lib_bundle option to the CONFIG variable:
TEMPLATE = lib
CONFIG += lib_bundle
FRAMEWORK_HEADERS.version = Versions
FRAMEWORK_HEADERS.path = Headers
QMAKE_BUNDLE_DATA += FRAMEWORK_HEADERS
Note that, if a project is later moved on the disk, qmake must be run again to process the
project file and create a new Xcode project file.
Windows
Features specific to this platform include support for creating Visual Studio project files and
handling manifest files when deploying Qt applications developed using Visual Studio 2005.
qmake -tp vc
qmake -tp vc -r
Each time you update the project file, you need to run qmake to generate an updated Visual
Studio project.
Note: If you are using the Visual Studio Add-in, you can import .pro files via the Qt-
>Import from .pro file menu item.
CONFIG -= embed_manifest_exe
Also, the manifest embedding for DLLs can be removed with the following assignment to
theCONFIG variable:
CONFIG -= embed_manifest_dll
This is discussed in more detail in the deployment guide for Windows.
Symbian platform
Features specific to this platform include handling of static data, capabilities, stack and heap
size, compiler specific options, and unique identifiers for the application or library.
TARGET.EPOCALLOWDLLDATA = 1
TARGET.EPOCSTACKSIZE = 0x8000
The default values depend on the version of the Symbian SDK you're using, however, the Qt
toolchain sets this to the maximum possible value and this should not be changed.
QMAKE_CXXFLAGS.CW += -O2
QMAKE_CXXFLAGS.ARMCC += -O0
Unique identifiers
Symbian applications may have unique identifiers attached to them. Here is how to define
them in a project file:
There are four available types of IDs supported: UID2, UID3, SID, and VID. They are
specified like this:
TARGET.UID2 = 0x00000001
TARGET.UID3 = 0x00000002
TARGET.SID = 0x00000003
TARGET.VID = 0x00000004
If SID is not specified, it defaults to the same value as UID3. If UID3 is not specified, qmake
will automatically generate a UID3 suitable for development and debugging. This value
should be manually specified for applications that are to be released. In order to obtain an
official UID, please contact http:\www.symbiansigned.com. Both SID and VID default to
empty values.
There exists one UID1 too, but this should not be touched by any application.
The UID2 has a specific value for different types of files - e.g. apps/exes are always
0x100039CE. The toolchain will set this for value for the most common file types like,
EXE/APP and shared library DLL.
For more information about unique identifiers and their meaning for Symbian applications,
please refer to the
http://developer.symbian.org/main/documentation/reference/s3/pdk/GUID-380A8C4F-
3EB6-5E1C-BCFB-ED5B866136D9.html
Capabilities
Capabilities define extra privileges for the application, such as the ability to list all files on
the file system. Capabilities are defined in the project file like this:
TARGET.CAPABILITY += AllFiles
For more information about capabilities, please refer to the Symbian SDK documentat
Operators
In many project files, the assignment (=) and append (+=) operators can be used to include
all the information about a project. The typical pattern of use is to assign a list of values to
a variable, and append more values depending on the result of various tests.
Since qmake defines certain variables using default values, it is sometimes necessary to use
the removal (-=) operator to filter out values that are not required. The following operators
can be used to manipulate the contents of variables.
The = operator assigns a value to a variable:
TARGET = myapp
The above line sets the TARGET variable to myapp. This will overwrite any values previously
set for TARGET with myapp.
The += operator appends a new value to the list of values in a variable:
DEFINES += QT_DLL
The above line appends QT_DLL to the list of pre-processor defines to be put in the
generated Makefile.
The -= operator removes a value from the list of values in a variable:
DEFINES -= QT_DLL
The above line removes QT_DLL from the list of pre-processor defines to be put in the
generated Makefile.
The *= operator adds a value to the list of values in a variable, but only if it is not already
present. This prevents values from being included many times in a variable. For example:
DEFINES *= QT_DLL
In the above line, QT_DLL will only be added to the list of pre-processor defines if it is not
already defined. Note that the unique() function can also be used to ensure that a
variables only contains one instance of each value.
The ~= operator replaces any values that match a regular expression with the specified
value:
DEFINES ~= s/QT_[DT].+/QT
In the above line, any values in the list that start with QT_D or QT_T are replaced with QT.
The $$ operator is used to extract the contents of a variable, and can be used to pass
values between variables or supply them to functions:
message($$EVERYTHING)
Scopes
Scopes are similar to if statements in procedural programming languages. If a certain
condition is true, the declarations inside the scope are processed.
Syntax
Scopes consist of a condition followed by an opening brace on the same line, a sequence of
commands and definitions, and a closing brace on a new line:
<condition> {
<command or definition>
...
The opening brace must be written on the same line as the condition. Scopes may be
concatenated to include more than one condition; see below for examples.
win32 {
SOURCES += paintwidget_win.cpp
}
The above code will add the paintwidget_win.cpp file to the sources listed in the
generated Makefile if qmake is used on a Windows platform. If qmake is used on a platform
other than Windows, the define will be ignored.
The conditions used in a given scope can also be negated to provide an alternative set of
declarations that will be processed only if the original condition is false. For example,
suppose we want to process something on all platforms except for Windows. We can
achieve this by negating the scope like this:
!win32 {
SOURCES -= paintwidget_win.cpp
Scopes can be nested to combine more than one condition. For instance, if you want to
include a particular file for a certain platform only if debugging is enabled then you write the
following:
macx {
debug {
HEADERS += debugging.h
To save writing many nested scopes, you can nest scopes using the : operator. The nested
scopes in the above example can be rewritten in the following way:
macx:debug {
HEADERS += debugging.h
You may also use the : operator to perform single line conditional assignments; for
example:
win32:DEFINES += QT_DLL
win32|macx {
HEADERS += debugging.h
You can also provide alternative declarations to those within a scope by using an elsescope.
Each else scope is processed if the conditions for the preceding scopes are false. This
allows you to write complex tests when combined with other scopes (separated by
the: operator as above). For example:
win32:xml {
SOURCES += xmlhandler_win.cpp
} else:xml {
SOURCES += xmlhandler.cpp
} else {
message("Unknown configuration")
CONFIG += opengl
As a result of this operation, any scopes that test for opengl will be processed. We can use
this feature to give the final executable an appropriate name:
opengl {
TARGET = application-gl
} else {
TARGET = application
}
This feature makes it easy to change the configuration for a project without losing all the
custom settings that might be needed for a specific configuration. In the above code, the
declarations in the first scope are processed, and the final executable will be
calledapplication-gl. However, if opengl is not specified, the declarations in the second
scope are processed instead, and the final executable will be called application.
Since it is possible to put your own values on the CONFIG line, this provides you with a
convenient way to customize project files and fine-tune the generated Makefiles.
message($$QMAKESPEC)
linux-g++ {
message(Linux)
You can test for any other platform-compiler combination as long as a specification exists
for it in the mkspecs directory.
The scope unix is true for the Symbian platform.
Variables
Many of the variables used in project files are special variables that qmake uses when
generating Makefiles, such as DEFINES, SOURCES, and HEADERS. It is possible for you to
create variables for your own use; qmake creates new variables with a given name when it
encounters an assignment to that name. For example:
MY_VARIABLE = value
There are no restricitions on what you do to your own variables, as qmake will ignore them
unless it needs to evaluate them when processing a scope.
You can also assign the value of a current variable to another variable by prefixing $$ to the
variable name. For example:
MY_DEFINES = $$DEFINES
Now the MY_DEFINES variable contains what is in the DEFINES variable at this point in the
project file. This is also equivalent to:
MY_DEFINES = $${DEFINES}
The second notation allows you to append the contents of the variable to another value
without separating the two with a space. For example, the following will ensure that the
final executable will be given a name that includes the project template being used:
TARGET = myproject_$${TEMPLATE}
Variables can be used to store the contents of environment variables. These can be
evaluated at the time that qmake is run, or included in the generated Makefile for evaluation
when the project is built.
To obtain the contents of an environment value when qmake is run, use the $$
(...)operator:
DESTDIR = $$(PWD)
In the above assignment, the value of the PWD environment variable is read when the
project file is processed.
To obtain the contents of an environment value at the time when the generated Makefile is
processed, use the $(...) operator:
DESTDIR = $$(PWD)
DESTDIR = $(PWD)
In the above assignment, the value of PWD is read immediately when the project file is
processed, but $(PWD) is assigned to DESTDIR in the generated Makefile. This makes the
build process more flexible as long as the environment variable is set correctly when the
Makefile is processed.
The special $$[...] operator can be used to access various configuration options that were
set when Qt was built:
message(Documentation: $$[QT_INSTALL_DOCS])
message(Libraries: $$[QT_INSTALL_LIBS])
message(Plugins: $$[QT_INSTALL_PLUGINS])
message(Settings: $$[QT_INSTALL_SETTINGS])
message(Examples: $$[QT_INSTALL_EXAMPLES])
message(Demonstrations: $$[QT_INSTALL_DEMOS])
The variables accessible with this operator are typically used to enable third party plugins
and components to be integrated with Qt. For example, a Qt Designer plugin can be
installed alongside Qt Designer's built-in plugins if the following declaration is made in its
project file:
target.path = $$[QT_INSTALL_PLUGINS]/designer
INSTALLS += target
HEADERS = model.h
HEADERS += $$OTHER_HEADERS
HEADERS = $$unique(HEADERS)
This type of function should be used on the right-hand side of assignments (i.e, as an
operand).
It is possible to define your own functions for processing the contents of variables. These
functions can be defined in the following way:
defineReplace(functionName){
#function code
The following example function takes a variable name as its only argument, extracts a list of
values from the variable with the eval() built-in function, and compiles a list of files:
defineReplace(headersAndSources) {
variable = $$1
names = $$eval($$variable)
headers =
sources =
for(name, names) {
header = $${name}.h
exists($$header) {
headers += $$header
source = $${name}.cpp
exists($$source) {
sources += $$source
return($$headers $$sources)
Conditional Functions
qmake provides built-in functions that can be used as conditions when writing scopes. These
functions do not return a value, but instead indicate "success" or "failure":
count(options, 2) {
defineTest(allFiles) {
files = $$ARGS
for(file, files) {
!exists($$file) {
return(false)
return(true)
CONFIG += myfeatures
With this addition to the CONFIG variable, qmake will search the locations listed above for
the myfeatures.prf file after it has finished parsing your project file. On Unix systems, it
will look for the following file:
1. $QMAKEFEATURES/myfeatures.prf (for each directory listed in
the QMAKEFEATURESenvironment variable)
4. $QMAKEPATH/mkspecs/features/unix/myfeatures.prf and$QMAKEPATH/mkspecs/fe
atures/myfeatures.prf (for each directory listed in theQMAKEPATH environment
variable)
5. $QMAKESPEC/features/unix/myfeatures.prf and$QMAKESPEC/features/myfeature
s.prf
6. data_install/mkspecs/features/unix/myfeatures.prf anddata_install/mkspec
s/features/myfeatures.prf
7. $QMAKESPEC/../features/unix/myfeatures.prf and$QMAKESPEC/../features/myf
eatures.prf
Mac OS X
o Makefile
o Xcode
Unix
o GCC 3.4 and above
#include <stdlib>
#include <iostream>
#include <vector>
#include <QPushButton>
#include <QLabel>
#include "thirdparty/include/libmain.h"
#include "my_stable_class.h"
...
#endif
Note that a precompiled header file needs to separate C includes from C++ includes, since
the precompiled header file for C files may not contain C++ code.
Project Options
To make your project use PCH, you only need to define the PRECOMPILED_HEADER variable in
your project file:
PRECOMPILED_HEADER = stable.h
qmake will handle the rest, to ensure the creation and use of the precompiled header file.
You do not need to include the precompiled header file in HEADERS, as qmake will do this if
the configuration supports PCH.
All platforms that support precompiled headers have the configuration
optionprecompile_header set. Using this option, you may trigger conditional blocks in your
project file to add settings when using PCH. For example:
precompile_header:!isEmpty(PRECOMPILED_HEADER) {
DEFINES += USING_PCH
PRECOMPILED_HEADER = window.h
SOURCES = window.cpp
To avoid potential conflicts like these, it is good practice to ensure that header files that will
be precompiled are given distinctive names.
Example Project
You can find the following source code in the examples/qmake/precompile directory in the
Qt distribution:
mydialog.ui
<author></author>
<comment></comment>
<exportmacro></exportmacro>
<class>MyDialog</class>
<rect>
<x>0</x>
<y>0</y>
<width>401</width>
<height>70</height>
</rect>
</property>
<string>Mach 2!</string>
</property>
<number>9</number>
</property>
<number>6</number>
</property>
<item>
<string>Join the life in the fastlane; - PCH enable your project today!
-</string>
</property>
</widget>
</item>
<item>
<string>&Quit</string>
</property>
<property name="shortcut" >
<string>Alt+Q</string>
</property>
</widget>
</item>
</layout>
</widget>
<pixmapfunction>qPixmapFromMimeSource</pixmapfunction>
<resources/>
<connections/>
</ui>
stable.h
# include <iostream>
# include <QApplication>
# include <QPushButton>
# include <QLabel>
#endif
myobject.h
#include <QObject>
public:
MyObject();
~MyObject();
};
myobject.cpp
#include <iostream>
#include <QDebug>
#include <QObject>
#include "myobject.h"
MyObject::MyObject()
: QObject()
util.cpp
void util_function_does_nothing()
// Nothing here...
int x = 0;
++x;
main.cpp
#include <QApplication>
#include <QPushButton>
#include <QLabel>
#include "myobject.h"
#include "mydialog.h"
int main(int argc, char **argv)
MyObject obj;
MyDialog dialog;
dialog.show();
return app.exec();
precompile.pro
TEMPLATE = app
LANGUAGE = C++
PRECOMPILED_HEADER = stable.h
HEADERS = stable.h \
mydialog.h \
myobject.h
SOURCES = main.cpp \
mydialog.cpp \
myobject.cpp \
util.cpp
FORMS = mydialog.ui
qmake Reference
This reference is a detailed index of all the variables and function that are available for use
in qmakeproject files.
Variable Reference
The qmake Variable Reference describes the variables that are recognized by qmake when
configuring the build process for projects.
Function Reference
The qmake Function Reference describes the function that can be used to process the
contents of variables defined in project files.
BLD_INF_RULES
This is only used on the Symbian platform.
Generic bld.inf file content can be specified withBLD_INF_RULES variables. The section
of bld.inffile where each rule goes is appended toBLD_INF_RULES with a dot.
For example:
my_exports = \
"foo.h /epoc32/include/mylib/foo.h" \
"bar.h /epoc32/include/mylib/bar.h"
BLD_INF_RULES.prj_exports += my_exports
myextension = \
"$${LITERAL_HASH}if defined(WINSCW)" \
"end"
BLD_INF_RULES.prj_extensions += myextension
Any rules you define will be added after automatically generated rules in each section.
CONFIG
The CONFIG variable specifies project configuration and compiler options. The values will be
recognized internally by qmake and have special meaning. They are as follows.
These CONFIG values control compilation flags:
Option Description
release The project is to be built in release mode. This is ignored if debug is also specified.
debug_and_release The project is built in bothdebug and release modes. This can have some unexpected side effects (see below
for more information).
build_all If debug_and_release is specified, the project is built in both debug and release modes by default.
ordered When using the subdirstemplate, this option specifies that the directories listed should be processed in
the order in which they are given.
warn_on The compiler should output as many warnings as possible. This is ignored if warn_off is specified.
make all
When linking a library, qmake relies on the underlying platform to know what other libraries
this library links against. However, if linking statically, qmake will not get this information
unless we use the followingCONFIG options:
Option Description
create_prl This option enables qmake to track these dependencies. When this option is enabled, qmake will create a file
ending in .prl which will save meta-information about the library (see Library Dependencies for more info).
Option Description
link_prl When this is enabled, qmake will process all libraries linked to by the application and find their meta-information
(see Library Dependencies for more info).
Please note that create_prl is required whenbuilding a static library, while link_prl is
required when using a static library.
On Windows (or if Qt is configured with -debug_and_release, adding the build_all option
to the CONFIG variable makes this rule the default when building the project, and
installation targets will be created for both debug and release builds.
Additionally, adding debug_and_release to theCONFIG variable will cause
both debug and releaseto be defined in the contents of CONFIG. When the project file is
processed, the scopes that test for each value will be processed for both debug and release
modes. The build_pass variable will be set for each of these mode, and you can test for
this to perform build-specific tasks. For example:
build_pass:CONFIG(debug, debug|release) {
qt The target is a Qt application/library and requires the Qt library and header files. The proper include
and library paths for the Qt library will automatically be added to the project. This is defined by
default, and can be fine-tuned with the\l{#qt}{QT}variable.
thread The target is a multi-threaded application or library. The proper defines and compiler flags will
automatically be added to the project.
x11 The target is a X11 application or library. The proper include paths and libraries will automatically be
added to the project.
windows The target is a Win32 window application (app only). The proper include paths, compiler flags and
libraries will automatically be added to the project.
console The target is a Win32 console application (app only). The proper include paths, compiler flags and
libraries will automatically be added to the project.
shared The target is a shared object/DLL. The proper include paths, compiler flags and libraries will
automatically be added to the project.
dll
Option Description
dylib
static The target is a static library (lib only). The proper compiler flags will automatically be added to the
project.
staticlib
plugin The target is a plugin (lib only). This enables dll as well.
uic3 Configures qmake to run uic3 on the content of FORMS3 if defined; otherwise the contents
of FORMS will be processed instead.
no_lflags_merge Ensures that the list of libraries stored in theLIBS variable is not reduced to a list of unique values
before it is used.
flat When using the vcapp template this will put all the source files into the source group and the header files
into the header group regardless of what directory they reside in. Turning this option off will group the files
within the source/header group depending on the directory they reside. This is turned on by default.
embed_manifest_dll Embeds a manifest file in the DLL created as part of a library project.
embed_manifest_exe Embeds a manifest file in the DLL created as part of an application project.
incremental Used to enable or disable incremental linking in Visual C++, depending on whether this feature is enabled
or disabled by default.
See qmake Platform Notes for more information on the options for embedding manifest
files.
These options only have an effect on Mac OS X:
Option Description
stdbinary Builds an Open C binary (i.e. STDDLL, STDEXE, or STDLIB, depending on the target binary type.)
no_icon Doesn't generate resources needed for displaying an icon for executable in application menu (app only).
symbian_test Places mmp files and extension makefiles under test sections in generated bld.inf instead of their regular
sections. Note that this only affects automatically generated bld.inf content; the content added
viaBLD_INF_RULES variable is not affected.
localize_deployment Makes lupdate tool add fields for application captions and package file names into
generated .ts files. Qmake generates properly localized .loc and .pkg files based on available
translations. Translation file name bodies must end with underscore and the language code for deployment
localization to work. E.g. myapp_en.ts. Note: All languages supported by Qt are not supported by
Symbian, so some .ts files may be ignored by qmake.
...
newstuff {
SOURCES += new.cpp
HEADERS += new.h
DEFINES
qmake adds the values of this variable as compiler C preprocessor macros (-D option).
For example:
DEFINES += USE_MY_STUFF QT_DLL
DEF_FILE
This is only used on Windows when using the app template, and on Symbian when building
a shared DLL.
Specifies a .def file to be included in the project. On Symbian a directory may be specified
instead, in which case the real files will be located under the standard Symbian
directoriesbwins and eabi.
DEPENDPATH
This variable contains the list of all directories to look in to resolve dependencies. This will
be used when crawling through included files.
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 cetestexecutable.
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.path = \some\path\on\device
someother.sources = C:\additional\files\*
someother.path = \myFiles\path2
customplugin.sources = customimageplugin.dll
customplugin.sources += c:\myplugins\othercustomimageplugin.dll
customplugin.path = imageformats
dynamiclibrary.path = \sys\bin
globalplugin.sources = someglobalimageplugin.dll
globalplugin.path = \resource\qt\plugins\imageformats
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.pkg_prerules is used for defining vendor information,
dependencies, custom package headers, and the like, while pkg_postrules is used for
custom file deployment and embedded sis directives. 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
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, three separate PKG files are generated:
<app>_template.pkg - For application SIS file. Rules suffix: .main
DEPLOYMENT += my_note
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, a default deployment is generated for all application projects. You
can modify the autogenerated default deployment via following DEPLOYMENT variable values:
default_bin_deployment - Application executable
default_resource_deployment - Application resources, including icon
default_reg_deployment - Application registration file
For example:
dep_note.sources = install_note.txt
DEPLOYMENT += dep_note
This will show a message box that gives user an option to cancel the installation and then
automatically runs the application after installation is complete.
Note: Automatically running the applications after install may require signing the package
with better than self-signed certificate, depending on the phone model. Additionally, some
tools such as Runonphone may not work properly with sis packages that automatically run
the application upon install.
On the Symbian platform, the default package name and the default name that appears in
application menu is derived from the TARGET variable. Often the default is not optimal for
displaying to end user. To set a better display name for these purposes,
useDEPLOYMENT.display_name variable:
DEPLOYMENT.display_name = My Qt App
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_PLUGIN
This is only used on Windows CE and the Symbian platform.
This variable specifies the Qt plugins that will be deployed. All plugins available in Qt can be
explicitly deployed to the device. See Static Plugins for a complete list.
Note: In Windows CE, No plugins will be deployed automatically. If the application depends
on plugins, these plugins have to be specified manually.
Note: On the Symbian platform, all plugins supported by this variable will be deployed by
default with Qt libraries, so generally using this variable is not needed.
For example:
DEPLOYMENT_PLUGIN += qjpeg
This will upload the jpeg imageformat plugin to the plugins directory on the Windows CE
device.
DESTDIR
Specifies where to put the target file.
For example:
DESTDIR = ../../lib
DESTDIR_TARGET
This variable is set internally by qmake, which is basically the DESTDIR variable with
theTARGET variable appened at the end. The value of this variable is typically handled
by qmakeor qmake.conf and rarely needs to be modified.
DLLDESTDIR
Specifies where to copy the target dll.
DISTFILES
This variable contains a list of files to be included in the dist target. This feature is
supported by UnixMake specs only.
For example:
DISTFILES += ../program.txt
DSP_TEMPLATE
This variable is set internally by qmake, which specifies where the dsp template file for
basing generated dsp files is stored. The value of this variable is typically handled
by qmakeor qmake.conf and rarely needs to be modified.
FORMS
This variable specifies the UI files (see Qt Designer) to be processed through uic before
compiling. All dependencies, headers and source files required to build these UI files will
automatically be added to the project.
For example:
FORMS = mydialog.ui \
mywidget.ui \
myconfig.ui
If FORMS3 is defined in your project, then this variable must contain forms for uic, and not
uic3. If CONFIG contains uic3, and FORMS3 is not defined, the this variable must contain
only uic3 type forms.
FORMS3
This variable specifies the old style UI files to be processed through uic3 before compiling,
when CONFIG contains uic3. All dependencies, headers and source files required to build
these UI files will automatically be added to the project.
For example:
FORMS3 = my_uic3_dialog.ui \
my_uic3_widget.ui \
my_uic3_config.ui
GUID
Specifies the GUID that is set inside a .vcproj file. The GUID is usually randomly
determined. However, should you require a fixed GUID, it can be set using this variable.
This variable is specific to .vcproj files only; it is ignored otherwise.
HEADERS
Defines the header files for the project.
qmake will generate dependency information (unless -nodepend is specified on
the command line) for the specified headers. qmake will also automatically detect if moc is
required by the classes in these headers, and add the appropriate dependencies and files to
the project for generating and linking the moc files.
For example:
HEADERS = myclass.h \
login.h \
mainwindow.h
See also SOURCES.
ICON
This variable is used only in MAC and the Symbian platform to set the application icon.
Please see the application icon documentation for more information.
INCLUDEPATH
This variable specifies the #include directories which should be searched when compiling the
project. Use ';' or a space as the directory separator.
For example:
To specify a path containing spaces, quote the path using the technique mentioned in
theqmake Project Files document. For example, paths with spaces can be specified on
Windows and Unix platforms by using the quote() function in the following way:
INSTALLS
This variable contains a list of resources that will be installed when make install or a
similar installation procedure is executed. Each item in the list is typically defined with
attributes that provide information about where it will be installed.
For example, the following target.path definition describes where the build target will be
installed, and the INSTALLS assignment adds the build target to the list of existing
resources to be installed:
target.path += $$[QT_INSTALL_PLUGINS]/imageformats
INSTALLS += target
Note that qmake will skip files that are executable. If you need to install executable files,
you can unset the files' executable flags.
LEXIMPLS
This variable contains a list of lex implementation files. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
LEXOBJECTS
This variable contains the names of intermediate lex object files.The value of this variable is
typically handled by qmake and rarely needs to be modified.
LEXSOURCES
This variable contains a list of lex source files. All dependencies, headers and source files
will automatically be added to the project for building these lex files.
For example:
LEXSOURCES = lexer.l
LIBS
This variable contains a list of libraries to be linked into the project. You can use the Unix -
l(library) and -L (library path) flags and qmake will do the correct thing with these libraries
on Windows and the Symbian platform (namely this means passing the full path of the
library to the linker). The only limitation to this is the library must exist, for qmake to find
which directory a -l lib lives in.
For example:
win32:LIBS += c:/mylibs/math.lib
To specify a path containing spaces, quote the path using the technique mentioned in
theqmake Project Files document. For example, paths with spaces can be specified on
Windows and Unix platforms by using the quote() function in the following way:
CONFIG += no_lflags_merge
LITERAL_HASH
This variable is used whenever a literal hash character (#) is needed in a variable
declaration, perhaps as part of a file name or in a string passed to some external
application.
For example:
message($$join(urlPieces, $$LITERAL_HASH))
MAKEFILE
This variable specifies the name of the Makefile which qmake should use when outputting
the dependency information for building a project. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
Note: On the Symbian platform, this variable is ignored.
MAKEFILE_GENERATOR
This variable contains the name of the Makefile generator to use when generating a
Makefile. The value of this variable is typically handled internally by qmake and rarely needs
to be modified.
MMP_RULES
This is only used on the Symbian platform.
Generic MMP file content can be specified with this variable.
For example:
This will add the specified statement to the end of the generated MMP file.
It is also possible to add multiple rows in a single block. Each double quoted string will be
placed on a new row in the generated MMP file.
For example:
myBlock = \
"TARGET bar" \
"TARGETPATH private\10001234" \
"HEADER" \
"LANG 01" \
"END"
MMP_RULES += myBlock
If you need to include a hash (#) character inside the MMP_RULES statement, it can be done
with the variable LITERAL_HASH as follows:
myIfdefBlock = \
"$${LITERAL_HASH}ifdef WINSCW" \
"DEFFILE hello_winscw.def" \
"$${LITERAL_HASH}endif"
MMP_RULES += myIfdefBlock
MYVARIABLES = LIB
addMMPRules(MYCONDITIONS, MYVARIABLES)
Note: You should not use this variable to add MMP statements that are explicitly supported
by their own variables, such as TARGET.EPOCSTACKSIZE. Doing so could result in duplicate
statements in the MMP file.
MOC_DIR
This variable specifies the directory where all intermediate moc files should be placed.
For example:
unix:MOC_DIR = ../myproject/tmp
win32:MOC_DIR = c:/myproject/tmp
OBJECTS
This variable is generated from the SOURCES variable. The extension of each source file will
have been replaced by .o (Unix) or .obj (Win32). The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
OBJECTS_DIR
This variable specifies the directory where all intermediate objects should be placed.
For example:
unix:OBJECTS_DIR = ../myproject/tmp
win32:OBJECTS_DIR = c:/myproject/tmp
OBJMOC
This variable is set by qmake if files can be found that contain
the Q_OBJECT macro. OBJMOCcontains the name of all intermediate moc object files. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
POST_TARGETDEPS
All libraries that the target depends on can be listed in this variable. Some backends do not
support this, these include MSVC Dsp, and ProjectBuilder .pbproj files. Generally this is
supported internally by these build tools, this is useful for explicitly listing dependant static
libraries.
This list will go after all builtin (and $$PRE_TARGETDEPS) dependencies.
PRE_TARGETDEPS
All libraries that the target depends on can be listed in this variable. Some backends do not
support this, these include MSVC Dsp, and ProjectBuilder .pbproj files. Generally this is
supported internally by these build tools, this is useful for explicitly listing dependant static
libraries.
This list will go before all builtin dependencies.
PRECOMPILED_HEADER
This variable indicates the header file for creating a precompiled header file, to increase the
compilation speed of a project. Precompiled headers are currently only supported on some
platforms (Windows - all MSVC project types, Mac OS X - Xcode, Makefile, Unix - gcc 3.3
and up).
On other platforms, this variable has different meaning, as noted below.
This variable contains a list of header files that require some sort of pre-compilation step
(such as with moc). The value of this variable is typically handled
by qmake or qmake.confand rarely needs to be modified.
PWD
This variable contains the full path leading to the directory where the qmake project file
(project.pro) is located.
OUT_PWD
This variable contains the full path leading to the directory where qmake places the
generated Makefile.
QMAKE
This variable contains the name of the qmake program itself and is placed in generated
Makefiles. The value of this variable is typically handled by qmake or qmake.conf and rarely
needs to be modified.
QMAKESPEC
This variable contains the name of the qmake configuration to use when generating
Makefiles. The value of this variable is typically handled by qmake and rarely needs to be
modified.
Use the QMAKESPEC environment variable to override the qmake configuration. Note that,
due to the way qmake reads project files, setting the QMAKESPEC environment variable from
within a project file will have no effect.
QMAKE_APP_FLAG
This variable is empty unless the app TEMPLATE is specified. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified. Use the
following instead:
app {
QMAKE_APP_OR_DLL
This variable is empty unless the app or dll TEMPLATE is specified. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_AR_CMD
This is used on Unix platforms only.
This variable contains the command for invoking the program which creates, modifies and
extracts archives. The value of this variable is typically handled by qmake or qmake.confand
rarely needs to be modified.
QMAKE_BUNDLE_DATA
This variable is used to hold the data that will be installed with a library bundle, and is often
used to specify a collection of header files.
For example, the following lines add path/to/header_one.h and path/to/header_two.h to
a group containing information about the headers supplied with the framework:
FRAMEWORK_HEADERS.version = Versions
FRAMEWORK_HEADERS.path = Headers
QMAKE_BUNDLE_DATA += FRAMEWORK_HEADERS
The last line adds the information about the headers to the collection of resources that will
be installed with the library bundle.
Library bundles are created when the lib_bundle option is added to the CONFIG variable.
See qmake Platform Notes for more information about creating library bundles.
This is used on Mac OS X only.
QMAKE_BUNDLE_EXTENSION
This variable defines the extension to be used for library bundles. This allows frameworks to
be created with custom extensions instead of the standard .framework directory name
extension.
For example, the following definition will result in a framework with
the .myframeworkextension:
QMAKE_BUNDLE_EXTENSION = .myframework
QMAKE_CC
This variable specifies the C compiler that will be used when building projects containing C
source code. Only the file name of the compiler executable needs to be specified as long as
it is on a path contained in the PATH variable when the Makefile is processed.
QMAKE_CFLAGS_DEBUG
This variable contains the flags for the C compiler in debug mode.The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CFLAGS_MT
This variable contains the compiler flags for creating a multi-threaded application or when
the version of Qt that you link against is a multi-threaded statically linked library. The value
of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CFLAGS_MT_DBG
This variable contains the compiler flags for creating a debuggable multi-threaded
application or when the version of Qt that you link against is a debuggable multi-threaded
statically linked library. The value of this variable is typically handled
by qmake orqmake.conf and rarely needs to be modified.
QMAKE_CFLAGS_MT_DLL
This is used on Windows only.
This variable contains the compiler flags for creating a multi-threaded dll or when the
version of Qt that you link against is a multi-threaded dll. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CFLAGS_MT_DLLDBG
This is used on Windows only.
This variable contains the compiler flags for creating a debuggable multi-threaded dll or
when the version of Qt that you link against is a debuggable multi-threaded statically linked
library. The value of this variable is typically handled by qmake or qmake.conf and rarely
needs to be modified.
QMAKE_CFLAGS_RELEASE
This variable contains the compiler flags for creating a non-debuggable application. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CFLAGS_SHLIB
This is used on Unix platforms only.
This variable contains the compiler flags for creating a shared library. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CFLAGS_THREAD
This variable contains the compiler flags for creating a multi-threaded application. The value
of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CFLAGS_WARN_OFF
This variable is not empty if the warn_off CONFIG option is specified. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CFLAGS_WARN_ON
This variable is not empty if the warn_on CONFIG option is specified. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CLEAN
This variable contains any files which are not generated files (such as moc and uic
generated files) and object files that should be removed when using "make clean".
QMAKE_CXX
This variable specifies the C++ compiler that will be used when building projects containing
C++ source code. Only the file name of the compiler executable needs to be specified as
long as it is on a path contained in the PATH variable when the Makefile is processed.
QMAKE_CXXFLAGS
This variable contains the C++ compiler flags that are used when building a project. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified. The flags specific to debug and release modes can be adjusted by modifying
theQMAKE_CXXFLAGS_DEBUG and QMAKE_CXXFLAGS_RELEASE variables, respectively.
Note: On the Symbian platform, this variable can be used to pass architecture specific
options to each compiler in the Symbian build system. For example:
QMAKE_CXXFLAGS.CW += -O2
QMAKE_CXXFLAGS.ARMCC += -O0
QMAKE_CXXFLAGS_MT
This variable contains the C++ compiler flags for creating a multi-threaded application. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CXXFLAGS_MT_DBG
This variable contains the C++ compiler flags for creating a debuggable multi-threaded
application. The value of this variable is typically handled by qmake or qmake.conf and
rarely needs to be modified.
QMAKE_CXXFLAGS_MT_DLL
This is used on Windows only.
This variable contains the C++ compiler flags for creating a multi-threaded dll. The value of
this variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CXXFLAGS_MT_DLLDBG
This is used on Windows only.
This variable contains the C++ compiler flags for creating a multi-threaded debuggable dll.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
QMAKE_CXXFLAGS_RELEASE
This variable contains the C++ compiler flags for creating an application. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CXXFLAGS_SHLIB
This variable contains the C++ compiler flags for creating a shared library. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_CXXFLAGS_THREAD
This variable contains the C++ compiler flags for creating a multi-threaded application. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CXXFLAGS_WARN_OFF
This variable contains the C++ compiler flags for suppressing compiler warnings. The value
of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_CXXFLAGS_WARN_ON
This variable contains C++ compiler flags for generating compiler warnings. The value of
this variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_DISTCLEAN
This variable removes extra files upon the invocation of make distclean.
QMAKE_EXTENSION_SHLIB
This variable contains the extention for shared libraries. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
Note that platform-specific variables that change the extension will override the contents of
this variable.
QMAKE_EXT_MOC
This variable changes the extention used on included moc files.
See also File Extensions.
QMAKE_EXT_UI
This variable changes the extention used on /e Designer UI files.
See also File Extensions.
QMAKE_EXT_PRL
This variable changes the extention used on created PRL files.
See also File Extensions, Library Dependencies.
QMAKE_EXT_LEX
This variable changes the extention used on files given to lex.
See also File Extensions, LEXSOURCES.
QMAKE_EXT_YACC
This variable changes the extention used on files given to yacc.
See also File Extensions, YACCSOURCES.
QMAKE_EXT_OBJ
This variable changes the extention used on generated object files.
See also File Extensions.
QMAKE_EXT_CPP
This variable changes the interpretation of all suffixes in this list of values as files of type C+
+ source code.
See also File Extensions.
QMAKE_EXT_H
This variable changes the interpretation of all suffixes in this list of values as files of type C
header files.
See also File Extensions.
QMAKE_EXTRA_COMPILERS
This variable contains the extra compilers/preprocessors that have been added
See also Customizing Makefile Output
QMAKE_EXTRA_TARGETS
This variable contains the extra targets that have been added
See also Customizing Makefile Output
QMAKE_FAILED_REQUIREMENTS
This variable contains the list of requirements that were failed to be met when qmake was
used. For example, the sql module is needed and wasn't compiled into Qt. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_FILETAGS
This variable contains the file tags needed to be entered into the Makefile, such as
SOURCES and HEADERS. The value of this variable is typically handled
by qmake orqmake.conf and rarely needs to be modified.
QMAKE_FRAMEWORK_BUNDLE_NAME
In a framework project, this variable contains the name to be used for the framework that is
built.
By default, this variable contains the same value as the TARGET variable.
See qmake Platform Notes for more information about creating frameworks and library
bundles.
This is used on Mac OS X only.
QMAKE_FRAMEWORK_VERSION
For projects where the build target is a Mac OS X framework, this variable is used to specify
the version number that will be applied to the framework that is built.
By default, this variable contains the same value as the VERSION variable.
See qmake Platform Notes for more information about creating frameworks.
This is used on Mac OS X only.
QMAKE_INCDIR
This variable contains the location of all known header files to be added to INCLUDEPATH
when building an application. The value of this variable is typically handled
by qmake orqmake.conf and rarely needs to be modified.
QMAKE_INCDIR_EGL
This variable contains the location of EGL header files to be added to INCLUDEPATH when
building an application with OpenGL/ES or OpenVG support. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_INCDIR_OPENGL
This variable contains the location of OpenGL header files to be added to INCLUDEPATH
when building an application with OpenGL support. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
If the OpenGL implementation uses EGL (most OpenGL/ES systems),
thenQMAKE_INCDIR_EGL may also need to be set.
QMAKE_INCDIR_OPENGL_ES1, QMAKE_INCDIR_OPENGL_ES2
These variables contain the location of OpenGL headers files to be added to INCLUDEPATH
when building an application with OpenGL ES 1 or OpenGL ES 2 support respectively.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
If the OpenGL implementation uses EGL (most OpenGL/ES systems),
thenQMAKE_INCDIR_EGL may also need to be set.
QMAKE_INCDIR_OPENVG
This variable contains the location of OpenVG header files to be added to INCLUDEPATH
when building an application with OpenVG support. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
If the OpenVG implementation uses EGL then QMAKE_INCDIR_EGL may also need to be
set.
QMAKE_INCDIR_QT
This variable contains the location of all known header file paths to be added to
INCLUDEPATH when building a Qt application. The value of this variable is typically handled
by qmake or qmake.conf and rarely needs to be modified.
QMAKE_INCDIR_THREAD
This variable contains the location of all known header file paths to be added to
INCLUDEPATH when building a multi-threaded application. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_INCDIR_X11
This is used on Unix platforms only.
This variable contains the location of X11 header file paths to be added to INCLUDEPATH
when building a X11 application. The value of this variable is typically handled
by qmake orqmake.conf and rarely needs to be modified.
QMAKE_INFO_PLIST
This is used on Mac OS X platforms only.
This variable contains the name of the property list file, .plist, you would like to include in
your Mac OS X application bundle.
In the .plist file, you can define some variables, e.g., @EXECUTABLE@, which qmake will
replace with the actual executable name. Other variables include @ICON@,
@TYPEINFO@,@LIBRARY@, and @SHORT_VERSION@.
Note: Most of the time, the default Info.plist is good enough.
QMAKE_LFLAGS
This variable contains a general set of flags that are passed to the linker. If you need to
change the flags used for a particular platform or type of project, use one of the specialized
variables for that purpose instead of this variable.
QMAKE_LFLAGS_CONSOLE
This is used on Windows only.
This variable contains link flags when building console programs. The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_CONSOLE_DLL
This is used on Windows only.
This variable contains link flags when building console dlls. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_DEBUG
This variable contains link flags when building debuggable applications. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_PLUGIN
This variable contains link flags when building plugins. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_RPATH
This is used on Unix platforms only.
Library paths in this definition are added to the executable at link time so that the added
paths will be preferentially searched at runtime.
QMAKE_LFLAGS_QT_DLL
This variable contains link flags when building programs that use the Qt library built as a dll.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
QMAKE_LFLAGS_RELEASE
This variable contains link flags when building applications for release. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_SHAPP
This variable contains link flags when building applications which are using
the app template. The value of this variable is typically handled
by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_SHLIB
This variable contains link flags when building shared libraries The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_SONAME
This variable specifies the link flags to set the name of shared objects, such as .so or .dll.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
QMAKE_LFLAGS_THREAD
This variable contains link flags when building multi-threaded projects. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LFLAGS_WINDOWS
This is used on Windows only.
This variable contains link flags when building Windows GUI projects (i.e. non-console
applications). The value of this variable is typically handled by qmake or qmake.conf and
rarely needs to be modified.
QMAKE_LFLAGS_WINDOWS_DLL
This is used on Windows only.
This variable contains link flags when building Windows DLL projects. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBDIR
This variable contains the location of all known library directories.The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBDIR_FLAGS
This is used on Unix platforms only.
This variable contains the location of all library directory with -L prefixed. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBDIR_EGL
This variable contains the location of the EGL library directory, when EGL is used with
OpenGL/ES or OpenVG. The value of this variable is typically handled
by qmake orqmake.conf and rarely needs to be modified.
QMAKE_LIBDIR_OPENGL
This variable contains the location of the OpenGL library directory.The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
If the OpenGL implementation uses EGL (most OpenGL/ES systems),
thenQMAKE_LIBDIR_EGL may also need to be set.
QMAKE_LIBDIR_OPENVG
This variable contains the location of the OpenVG library directory. The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
If the OpenVG implementation uses EGL, then QMAKE_LIBDIR_EGL may also need to be
set.
QMAKE_LIBDIR_QT
This variable contains the location of the Qt library directory.The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBDIR_X11
This is used on Unix platforms only.
This variable contains the location of the X11 library directory.The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS
This variable contains all project libraries. The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS_CONSOLE
This Windows-specific variable is no longer used.
Prior to Qt 4.2, this variable was used to list the libraries that should be linked against when
building a console application project on Windows. QMAKE_LIBS_WINDOW should now be
used instead.
QMAKE_LIBS_EGL
This variable contains all EGL libraries when building Qt with OpenGL/ES or OpenVG. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified. The usual value is -lEGL.
QMAKE_LIBS_OPENGL
This variable contains all OpenGL libraries. The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified.
If the OpenGL implementation uses EGL (most OpenGL/ES systems),
then QMAKE_LIBS_EGLmay also need to be set.
QMAKE_LIBS_OPENGL_QT
This variable contains all OpenGL Qt libraries.The value of this variable is typically handled
by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS_OPENGL_ES1, QMAKE_LIBS_OPENGL_ES2
These variables contain all the OpenGL libraries for OpenGL ES 1 and OpenGL ES 2.
The value of these variables is typically handled by qmake or qmake.conf and rarely needs
to be modified.
If the OpenGL implementation uses EGL (most OpenGL/ES systems),
then QMAKE_LIBS_EGLmay also need to be set.
QMAKE_LIBS_OPENVG
This variable contains all OpenVG libraries. The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified. The usual value is -lOpenVG.
Some OpenVG engines are implemented on top of OpenGL. This will be detected at
configure time and QMAKE_LIBS_OPENGL will be implicitly added
to QMAKE_LIBS_OPENVG wherever the OpenVG libraries are linked.
If the OpenVG implementation uses EGL, then QMAKE_LIBS_EGL may also need to be set.
QMAKE_LIBS_QT
This variable contains all Qt libraries.The value of this variable is typically handled
by qmakeor qmake.conf and rarely needs to be modified.
QMAKE_LIBS_QT_DLL
This is used on Windows only.
This variable contains all Qt libraries when Qt is built as a dll. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS_QT_OPENGL
This variable contains all the libraries needed to link against if OpenGL support is turned on.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
QMAKE_LIBS_QT_THREAD
This variable contains all the libraries needed to link against if thread support is turned on.
The value of this variable is typically handled by qmake or qmake.conf and rarely needs to
be modified.
QMAKE_LIBS_RT
This is used with Borland compilers only.
This variable contains the runtime library needed to link against when building an
application. The value of this variable is typically handled by qmake or qmake.conf and
rarely needs to be modified.
QMAKE_LIBS_RTMT
This is used with Borland compilers only.
This variable contains the runtime library needed to link against when building a multi-
threaded application. The value of this variable is typically handled
by qmake or qmake.confand rarely needs to be modified.
QMAKE_LIBS_THREAD
This is used on Unix and Symbian platforms only.
This variable contains all libraries that need to be linked against when building a multi-
threaded application. The value of this variable is typically handled
by qmake or qmake.confand rarely needs to be modified.
QMAKE_LIBS_WINDOWS
This is used on Windows only.
This variable contains all windows libraries.The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS_X11
This is used on Unix platforms only.
This variable contains all X11 libraries.The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified.
QMAKE_LIBS_X11SM
This is used on Unix platforms only.
This variable contains all X11 session management libraries. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LIB_FLAG
This variable is not empty if the lib template is specified. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_LINK_SHLIB_CMD
This variable contains the command to execute when creating a shared library. The value of
this variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_POST_LINK
This variable contains the command to execute after linking the TARGET together. This
variable is normally empty and therefore nothing is executed, additionally some backends
will not support this - mostly only Makefile backends.
QMAKE_PRE_LINK
This variable contains the command to execute before linking the TARGET together. This
variable is normally empty and therefore nothing is executed, additionally some backends
will not support this - mostly only Makefile backends.
QMAKE_LN_SHLIB
This variable contains the command to execute when creating a link to a shared library. The
value of this variable is typically handled by qmake or qmake.conf and rarely needs to be
modified.
QMAKE_MAC_SDK
This variable is used on Mac OS X when building universal binaries. This process is described
in more detail in the Deploying an Application on Mac OS X document.
QMAKE_MACOSX_DEPLOYMENT_TARGET
This variable only has an effect when building on Mac OS X. On that platform, the variable
will be forwarded to the MACOSX_DEPLOYMENT_TARGET environment variable, which is
interpreted by the compiler or linker. For more information, see the Deploying an
Application on Mac OS X document.
QMAKE_MAKEFILE
This variable contains the name of the Makefile to create. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_MOC_SRC
This variable contains the names of all moc source files to generate and include in the
project. The value of this variable is typically handled by qmake or qmake.conf and rarely
needs to be modified.
QMAKE_QMAKE
This variable contains the location of qmake if it is not in the path. The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_QT_DLL
This variable is not empty if Qt was built as a dll. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_RESOURCE_FLAGS
This variable is used to customize the list of options passed to the Resource Compiler in
each of the build rules where it is used. For example, the following line ensures that the -
threshold and -compress options are used with particular values each time that rcc is
invoked:
QMAKE_RPATH
This is used on Unix platforms only.
Is equivalent to QMAKE_LFLAGS_RPATH.
QMAKE_RPATHDIR
This is used on Unix platforms only.
A list of library directory paths, these paths are added to the executable at link time so that
the paths will be preferentially searched at runtime.
QMAKE_RUN_CC
This variable specifies the individual rule needed to build an object. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_RUN_CC_IMP
This variable specifies the individual rule needed to build an object. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_RUN_CXX
This variable specifies the individual rule needed to build an object. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_RUN_CXX_IMP
This variable specifies the individual rule needed to build an object. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_TARGET
This variable contains the name of the project target. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
QMAKE_UIC
This variable contains the location of uic if it is not in the path. The value of this variable is
typically handled by qmake or qmake.conf and rarely needs to be modified.
It can be used to specify arguments to uic as well, such as additional plugin paths. For
example:
QT
The values stored in the QT variable control which of the Qt modules are used by your
project.
The table below shows the options that can be used with the QT variable and the features
that are associated with each of them:
Option Features
network QtNetwork module
opengl QtOpenGL module
sql QtSql module
svg QtSvg module
xml QtXml module
qt3support Qt3Support module
By default, QT contains both core and gui, ensuring that standard GUI applications can be
built without further configuration.
If you want to build a project without the QtGui module, you need to exclude the gui value
with the "-=" operator; the following line will result in a minimal Qt project being built:
QT -= gui # Only the core module is used.
QTPLUGIN
This variable contains a list of names of static plugins that are to be compiled with an
application so that they are available as built-in resources.
QT_VERSION
This variable contains the current version of Qt.
QT_MAJOR_VERSION
This variable contains the current major version of Qt.
QT_MINOR_VERSION
This variable contains the current minor version of Qt.
QT_PATCH_VERSION
This variable contains the current patch version of Qt.
RC_FILE
This variable contains the name of the resource file for the application. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
RCC_DIR
This variable specifies the directory where all intermediate resource files should be placed.
For example:
unix:RCC_DIR = ../myproject/resources
win32:RCC_DIR = c:/myproject/resources
REQUIRES
This is a special variable processed by qmake. If the contents of this variable do not appear
in CONFIG by the time this variable is assigned, then a minimal Makefile will be generated
that states what dependencies (the values assigned to REQUIRES) are missing.
This is mainly used in Qt's build system for building the examples.
RESOURCES
This variable contains the name of the resource collection file (qrc) for the application.
Further information about the resource collection file can be found at The Qt Resource
System.
RES_FILE
This variable contains the name of the resource file for the application. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
RSS_RULES
This is only used on the Symbian platform.
Generic RSS file content can be specified with this variable. The syntax is similar
toMMP_RULES and BLD_INF_RULES.
For example:
myrssrules = \
"hidden = KAppIsHidden;" \
"launch = KAppLaunchInBackground;" \
RSS_RULES += myrssrules
This example will install the application to MyFolder in the Symbian platform application
shell. In addition it will make the application to be launched in background.
For detailed list of possible APP_REGISTRATION_INFO statements, please refer to the
Symbian platform help.
Note: You should not use RSS_RULES variable to set the following RSS
statements:app_file, localisable_resource_file, and localisable_resource_id.
These statements are internally handled by qmake.
There is a number of special modifiers you can attach to RSS_RULES to specify where in the
application registration file the rule will be written:
Modifier Location of the rule
the file_ownership_list ofAPP_REGISTRATION_INFO
For example:
This example will define service information for a fictional service that requires an icon to be
supplied via the opaque_data of the service information.
S60_VERSION
This is only used on the Symbian platform.
Contains the version number of the underlying S60 SDK; e.g. "5.0".
SIGNATURE_FILE
This is only used on Windows CE.
Specifies which signature file should be used to sign the project target.
Note: This variable will overwrite the setting you have specified in configure, with the -
signature option.
SOURCES
This variable contains the name of all source files in the project.
For example:
SOURCES = myclass.cpp \
login.cpp \
mainwindow.cpp
See also HEADERS
SRCMOC
This variable is set by qmake if files can be found that contain
the Q_OBJECT macro. SRCMOCcontains the name of all the generated moc files. The value of
this variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
SUBDIRS
This variable, when used with the subdirs template contains the names of all
subdirectories or project files that contain parts of the project that need be built. Each
subdirectory specified using this variable must contain its own project file.
For example:
SUBDIRS = kernel \
tools
It is essential that the project file in each subdirectory has the same name as the
subdirectory itself, so that qmake can find it. For example, if the subdirectory is
calledmyapp then the project file in that directory should be called myapp.pro.
If you need to ensure that the subdirectories are built in the order in which they are
specified, update the CONFIG variable to include the ordered option:
CONFIG += ordered
.file Specify the subproject pro file explicitly. Cannot be used in conjunction with .subdir modifier.
.condition Specifies a bld.inf define that must be true for subproject to be built. Available only on Symbian platform.
.depends This subproject depends on specified subproject. Available only on platforms that use makefiles.
.makefile The makefile of subproject. Available only on platforms that use makefiles.
.target Base string used for makefile targets related to this subproject. Available only on platforms that use makefiles.
For example, define two subdirectories, both of which reside in a different directory than
theSUBDIRS value, and one of the subdirectories must be built before the other:
my_executable.subdir = app
my_executable.depends = my_library
my_library.subdir = lib
For example, define a subdirectory that is only build for emulator builds in Qt for Symbian:
symbian {
SUBDIRS += emulator_dll
emulator_dll.condition = WINSCW
SYMBIAN_VERSION
This is only used on the Symbian platform.
Contains the version number of the underlying Symbian SDK; e.g. "9.2" or "Symbian3".
TARGET
This specifies the name of the target file.
For example:
TEMPLATE = app
TARGET = myapp
SOURCES = main.cpp
The project file above would produce an executable named myapp on unix and 'myapp.exe'
on windows.
TARGET.CAPABILITY
This is only used on the Symbian platform.
Specifies which platform capabilities the application should have. For more information,
please refer to the Symbian SDK documentation.
TARGET.EPOCALLOWDLLDATA
This is only used on the Symbian platform.
Specifies whether static data should be allowed in the application. Symbian disallows this by
default in order to save memory. To use it, set this to 1.
TARGET.EPOCHEAPSIZE
This is only used on the Symbian platform.
Specifies the minimum and maximum heap size of the application. The program will refuse
to run if the minimum size is not available when it starts. For example:
TARGET.EPOCSTACKSIZE
This is only used on the Symbian platform.
Specifies the maximum stack size of the application. For example:
TARGET.EPOCSTACKSIZE = 0x8000
TARGET.SID
This is only used on the Symbian platform.
Specifies which secure identifier to use for the target application or library. For more
information, see the Symbian SDK documentation.
TARGET.UID2
This is only used on the Symbian platform.
Specifies which unique identifier 2 to use for the target application or library. If this variable
is not specified, it defaults to the same value as TARGET.UID3. For more information, see
the Symbian SDK documentation.
TARGET.UID3
This is only used on the Symbian platform.
Specifies which unique identifier 3 to use for the target application or library. If this variable
is not specified, a UID3 suitable for development and debugging will be generated
automatically. However, applications being released should always define this variable. For
more information, see the Symbian SDK documentation.
TARGET.VID
This is only used on the Symbian platform.
Specifies which vendor identifier to use for the target application or library. For more
information, see the Symbian SDK documentation.
TARGET_EXT
This variable specifies the target's extension. The value of this variable is typically handled
by qmake or qmake.conf and rarely needs to be modified.
TARGET_x
This variable specifies the target's extension with a major version number. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
TARGET_x.y.z
This variable specifies the target's extension with version number. The value of this variable
is typically handled by qmake or qmake.conf and rarely needs to be modified.
TEMPLATE
This variable contains the name of the template to use when generating the project. The
allowed values are:
Option Description
app Creates a Makefile for building applications (the default). (See qmake Common Projects for more information.)
lib Creates a Makefile for building libraries. (See qmake Common Projects for more information.)
Option Description
subdirs Creates a Makefile for building targets in subdirectories. The subdirectories are specified using the SUBDIRS variable.
vcapp Windows only Creates an application project for Visual Studio. (See qmake Platform Notes for more information.)
vclib Windows only Creates a library project for Visual Studio. (See qmake Platform Notesfor more information.)
For example:
TEMPLATE = lib
SOURCES = main.cpp
TARGET = mylib
The template can be overridden by specifying a new template type with the -t command
line option. This overrides the template type after the .pro file has been processed. With
.pro files that use the template type to determine how the project is built, it is necessary to
declare TEMPLATE on the command line rather than use the -t option.
TRANSLATIONS
This variable contains a list of translation (.ts) files that contain translations of the user
interface text into non-native languages.
See the Qt Linguist Manual for more information about internationalization (i18n) and
localization (l10n) with Qt.
UICIMPLS
This variable contains a list of the generated implementation files by UIC. The value of this
variable is typically handled by qmake or qmake.conf and rarely needs to be modified.
UICOBJECTS
This variable is generated from the UICIMPLS variable. The extension of each file will have
been replaced by .o (Unix) or .obj (Win32). The value of this variable is typically handled
byqmake or qmake.conf and rarely needs to be modified.
UI_DIR
This variable specifies the directory where all intermediate files from uic should be placed.
This variable overrides both UI_SOURCES_DIR and UI_HEADERS_DIR.
For example:
unix:UI_DIR = ../myproject/ui
win32:UI_DIR = c:/myproject/ui
UI_HEADERS_DIR
This variable specifies the directory where all declaration files (as generated by uic) should
be placed.
For example:
unix:UI_HEADERS_DIR = ../myproject/ui/include
win32:UI_HEADERS_DIR = c:/myproject/ui/include
UI_SOURCES_DIR
This variable specifies the directory where all implementation files (as generated by uic)
should be placed.
For example:
unix:UI_SOURCES_DIR = ../myproject/ui/src
win32:UI_SOURCES_DIR = c:/myproject/ui/src
VERSION
This variable contains the version number of the application or library if either
the appTEMPLATE or the lib TEMPLATE is specified.
For example:
VERSION = 1.2.3
VER_MAJ
This variable contains the major version number of the library, if the lib template is
specified.
VER_MIN
This variable contains the minor version number of the library, if the lib template is
specified.
VER_PAT
This variable contains the patch version number of the library, if the lib template is
specified.
VPATH
This variable tells qmake where to search for files it cannot open. With this you may
tellqmake where it may look for things like SOURCES, and if it finds an entry in SOURCES
that cannot be opened it will look through the entire VPATH list to see if it can find the file
on its own.
See also DEPENDPATH.
YACCIMPLS
This variable contains a list of yacc source files. The value of this variable is typically
handled by qmake or qmake.conf and rarely needs to be modified.
YACCOBJECTS
This variable contains a list of yacc object files. The value of this variable is typically handled
by qmake or qmake.conf and rarely needs to be modified.
YACCSOURCES
This variable contains a list of yacc source files to be included in the project. All
dependencies, headers and source files will automatically be included in the project.
For example:
YACCSOURCES = moc.y
_PRO_FILE_
This variable contains the path to the project file in use.
For example, the following line causes the location of the project file to be written to the
console:
message($$_PRO_FILE_)
_PRO_FILE_PWD_
This variable contains the path to the directory containing the project file in use.
For example, the following line causes the location of the directory containing the project file
to be written to the console:
message($$_PRO_FILE_PWD_)
basename(variablename)
Returns the basename of the file specified. For example:
FILE = /etc/passwd
CONFIG(config)
[Conditional]
This function can be used to test for variables placed into the CONFIG variable. This is the
same as regular old style (tmake) scopes, but has the added advantage a second parameter
can be passed to test for the active config. As the order of values is important
in CONFIG variables (i.e. the last one set will be considered the active config for mutually
exclusive values) a second parameter can be used to specify a set of values to consider. For
example:
CONFIG = debug
CONFIG += release
Because release is considered the active setting (for feature parsing) it will be the CONFIG
used to generate the build file. In the common case a second parameter is not needed, but
for specific mutual exclusive tests it is invaluable.
contains(variablename, value)
[Conditional]
Succeeds if the variable variablename contains the value value; otherwise fails. You can
check the return value of this function using a scope.
For example:
HEADERS += network.h
SOURCES += network.cpp
The contents of the scope are only processed if the drivers variable contains the
value,network. If this is the case, the appropriate files are added to
the SOURCES and HEADERSvariables.
count(variablename, number)
[Conditional]
Succeeds if the variable variablename contains a list with the specified number of value;
otherwise fails.
This function is used to ensure that declarations inside a scope are only processed if the
variable contains the correct number of values; for example:
count(options, 2) {
dirname(file)
Returns the directory name part of the specified file. For example:
FILE = /etc/X11R6/XF86Config
error(string)
This function never returns a value. qmake displays the given string to the user, and exits.
This function should only be used for unrecoverable errors.
For example:
eval(string)
[Conditional]
Evaluates the contents of the string using qmake's syntax rules and returns true. Definitions
and assignments can be used in the string to modify the values of existing variables or
create new definitions.
For example:
eval(TARGET = myapp) {
message($$TARGET)
}
Note that quotation marks can be used to delimit the string, and that the return value can
be discarded if it is not needed.
exists(filename)
[Conditional]
Tests whether a file with the given filename exists. If the file exists, the function succeeds;
otherwise it fails. If a regular expression is specified for the filename, this function succeeds
if any file matches the regular expression specified.
For example:
exists( $(QTDIR)/lib/libqt-mt* ) {
CONFIG += thread
Note that "/" can be used as a directory separator, regardless of the platform in use.
find(variablename, substr)
Places all the values in variablename that match substr. substr may be a regular expression,
and will be matched accordingly.
MY_VAR2 will contain '-Lone -Ltwo -Lthree -Lfour -Lfive', and MY_VAR3 will contains 'three
two three'.
for(iterate, list)
This special test function will cause a loop to be started that iterates over all values in list,
setting iterate to each value in turn. As a convenience, if list is 1..10 then iterate will iterate
over the values 1 through 10.
The use of an else scope afer a condition line with a for() loop is disallowed.
For example:
LIST = 1 2 3
include(filename)
[Conditional]
Includes the contents of the file specified by filename into the current project at the point
where it is included. This function succeeds if filename is included; otherwise it fails. The
included file is processed immediately.
You can check whether the file was included by using this function as the condition for a
scope; for example:
include( shared.pri )
!include( options.pri ) {
OPTIONS -= custom
isEmpty(variablename)
[Conditional]
Succeeds if the variable variablename is empty; otherwise fails. This is the equivalent
ofcount( variablename, 0 ).
For example:
isEmpty( CONFIG ) {
member(variablename, position)
Returns the value at the given position in the list of items in variablename. If an item
cannot be found at the position specified, an empty string is returned. variablename is the
only required field. If not specified, position defaults to 0, causing the first value in the list
to be returned.
message(string)
This function simply writes a message to the console. Unlike the error() function, this
function allows processing to continue.
The above line causes "This is a message" to be written to the console. The use of quotation
marks is optional.
Note: By default, messages are written out for each Makefile generated by qmake for a
given project. If you want to ensure that messages only appear once for each project, test
the build_pass variable in conjunction with a scope to filter out messages during
builds; for example:
prompt(question)
Displays the specified question, and returns a value read from stdin.
quote(string)
Converts a whole string into a single entity and returns the result. Newlines, carriage
returns, and tabs can be specified in the string with \n \r and \t. The return value does not
contain either single or double quotation marks unless you explicitly include them yourself,
but will be placed into a single entry (for literal expansion).
This is a test.
sprintf(string, arguments...)
Replaces %1-%9 with the arguments passed in the comma-separated list of
functionarguments and returns the processed string.
system(command)
[Conditional]
Executes the given command in a secondary shell, and succeeds if the command returns with
a zero exit status; otherwise fails. You can check the return value of this function using a
scope:
For example:
system(ls /bin):HAS_BIN=FALSE
Alternatively, you can use this function to obtain stdout and stderr from the command, and
assign it to a variable. For example, you can use this to interrogate information about the
platform:
unique(variablename)
This will return a list of values in variable that are unique (that is with repetitive entries
removed). For example:
ARGS = 1 2 3 2 5 1
ARGS = $$unique(ARGS) #1 2 3 5
warning(string)
This function will always succeed, and will display the given string to the user. message() is
a synonym for warning().
Configuring qmake's Environment
Properties
qmake has a system of persistent information, this allows you to set a variable in qmake
once, and each time qmake is invoked this value can be queried. Use the following to set a
property in qmake:
Note: qmake -query will only list variables that you have previously set with qmake -set
VARIABLE VALUE.
This information will be saved into a QSettings object (meaning it will be stored in different
places for different platforms). As VARIABLE is versioned as well, you can set one value in
an older version of qmake, and newer versions will retrieve this value. However, if you
setVARIABLE for a newer version of qmake, the older version will not use this value. You can
however query a specific version of a variable if you prefix that version
of qmake toVARIABLE, as in the following example:
qmake also has the notion of builtin properties, for example you can query the installation
of Qt for this version of qmake with the QT_INSTALL_PREFIX property:
These built-in properties cannot have a version prefixed to them as they are not versioned,
and each version of qmake will have its own built-in set of these values. The list below
outlines the built-in properties:
QT_INSTALL_PREFIX - Where the version of Qt this qmake is built for resides
Finally, these values can be queried in a project file with a special notation such as:
QMAKE_VERS = $$[QMAKE_VERSION]
QMAKESPEC
qmake requires a platform and compiler description file which contains many default values
used to generate appropriate Makefiles. The standard Qt distribution comes with many of
these files, located in the mkspecs subdirectory of the Qt installation.
The QMAKESPEC environment variable can contain any of the following:
A complete path to a directory containing a qmake.conf file. In this case qmake will
open the qmake.conf file from within that directory. If the file does not exist, qmake will
exit with an error.
INSTALLS
It is common on Unix to also use the build tool to install applications and libraries; for
example, by invoking make install. For this reason, qmake has the concept of an install
set, an object which contains instructions about the way part of a project is to be installed.
For example, a collection of documentation files can be described in the following way:
documentation.path = /usr/local/program/doc
documentation.files = docs/*
INSTALLS += documentation
qmake will ensure that the specified files are copied to the installation directory. If you
require greater control over this process, you can also provide a definition for
the extramember of the object. For example, the following line tells qmake to execute a
series of commands for this install set:
The unix scope (see Scopes and Conditions) ensures that these particular commands are
only executed on Unix platforms. Appropriate commands for other platforms can be defined
using other scope rules.
Commands specified in the extra member are executed before the instructions in the other
members of the object are performed.
If you append a built-in install set to the INSTALLS variable and do not
specify files orextra members, qmake will decide what needs to be copied for you.
Currently, the only supported built-in install set is target:
target.path = /usr/local/myprogram
INSTALLS += target
In the above lines, qmake knows what needs to be copied, and will handle the installation
process automatically.
Cache File
The cache file is a special file qmake reads to find settings not specified in
the qmake.conffile, project files, or at the command line. If -nocache is not specified
when qmake is run, it will try to find a file called .qmake.cache in parent directories of the
current directory. If it fails to find this file, it will silently ignore this step of processing.
If it finds a .qmake.cache file then it will process this file first before it processes the
project file.
Library Dependencies
Often when linking against a library, qmake relies on the underlying platform to know what
other libraries this library links against, and lets the platform pull them in. In many cases,
however, this is not sufficent. For example, when statically linking a library, no other
libraries are linked to, and therefore no dependencies to those libraries are created.
However, an application that later links against this library will need to know where to find
the symbols that the static library will require. To help with this situation, qmake attempts to
follow a library's dependencies where appropriate, but this behavior must be explicitly
enabled by following two steps.
The first step is to enable dependency tracking in the library itself. To do this you must
tellqmake to save information about the library:
CONFIG += create_prl
This is only relevant to the lib template, and will be ignored for all others. When this option
is enabled, qmake will create a file ending in .prl which will save some meta-information
about the library. This metafile is just like an ordinary project file, but only contains internal
variable declarations. You are free to view this file and, if it is deleted, qmake will know to
recreate it when necessary, either when the project file is later read, or if a dependent
library (described below) has changed. When installing this library, by specifying it as a
target in an INSTALLS declaration, qmake will automatically copy the .prl file to the
installation path.
The second step in this process is to enable reading of this meta information in the
applications that use the static library:
CONFIG += link_prl
When this is enabled, qmake will process all libraries linked to by the application and find
their meta-information. qmake will use this to determine the relevant linking information,
specifically adding values to the application project file's list of DEFINES as well as LIBS.
Once qmake has processed this file, it will then look through the newly introduced libraries in
the LIBS variable, and find their dependent .prl files, continuing until all libraries have been
resolved. At this point, the Makefile is created as usual, and the libraries are linked explicitly
against the application.
The internals of the .prl file are left closed so they can easily change later. They are not
designed to be changed by hand, should only be created by qmake, and should not be
transferred between operating systems as they may contain platform-dependent
information.
File Extensions
Under normal circumstances qmake will try to use appropriate file extensions for your
platform. However, it is sometimes necessary to override the default choices for each
platform and explicitly define file extensions for qmake to use. This is achieved by redefining
certain built-in variables; for example the extension used for moc files can be redefined
with the following assignment in a project file:
QMAKE_EXT_MOC = .mymoc
The following variables can be used to redefine common file extensions recognized byqmake:
QMAKE_EXT_MOC - This modifies the extension placed on included moc files.
QMAKE_EXT_UI - This modifies the extension used for designer UI files (usually
inFORMS).
All of the above accept just the first value, so you must assign to it just one value that will
be used throughout your project file. There are two variables that accept a list of values:
QMAKE_EXT_CPP - Causes qmake to interpret all files with these suffixes as C++
source files.
QMAKE_EXT_H - Causes qmake to interpret all files with these suffixes as C and C++
header files.
mytarget.target = .buildfile
mytarget.depends = mytarget2
This is all you need to do to actually build custom targets. Of course, you may want to tie
one of these targets to the qmake build target. To do this, you simply need to include your
Makefile target in the list of PRE_TARGETDEPS.
The following tables are an overview of the options available to you with
theQMAKE_EXTRA_TARGETS variable.
Member Description
CONFIG Specific configuration options for the custom build target. See the CONFIG table for details.
depends The existing build targets that the custom build target depends on.
recurse Specifies which sub-targets should used when creating the rules in the Makefile to call in the sub-target specific
Makefile. This is only used whenrecursive is set in the CONFIG.
recurse_target Specifies the target that should be built via the sub-target Makefile for the rule in the Makefile. This adds
something like $(MAKE) -f Makefile.[subtarget] [recurse_target]. This is only used when recursive is set in
Member Description
the CONFIG.
recursive Indicates that rules should be created in the Makefile and thus call the relevant target inside the sub-target specific
Makefile. This defaults to creating an entry for each of the sub-targets.
For convenience, there is also a method of customizing projects for new compilers or
preprocessors:
new_moc.output = moc_${QMAKE_FILE_BASE}.cpp
new_moc.input = NEW_HEADERS
QMAKE_EXTRA_COMPILERS += new_moc
With the above definitions, you can use a drop-in replacement for moc if one is available.
The commands is executed on all arguments given to the NEW_HEADERS variable (from
theinput member), and the result is written to the file defined by the output member; this
file is added to the other source files in the project. Additionally, qmake will
executedepend_command to generate dependency information, and place this information in
the project as well.
These commands can easily be placed into a cache file, allowing subsequent project files to
add arguments to NEW_HEADERS.
The following tables are an overview of the options available to you with
theQMAKE_EXTRA_COMPILERS variable.
Member Description
commands The commands used for for generating the output from the input.
CONFIG Specific configuration options for the custom compiler. See the CONFIG table for details.
depend_command Specifies a command used to generate the list of dependencies for the output.
dependency_type Specifies the type of file the output is, if it is a known type (such as TYPE_C, TYPE_UI, TYPE_QRC) then it
is handled as one of those type of files.
input The variable that contains the files that should be processed with the custom compiler.
name A description of what the custom compiler is doing. This is only used in some backends.
output_function Specifies a custom qmake function that is used to specify the filename to be created.
variable_out The variable that the files created from the output should be added to.
commands The commands used for for generating the output from the input.
CONFIG Specific configuration options for the custom compiler. See the CONFIG table for details.
depend_command Specifies a command used to generate the list of dependencies for the output.
dependency_type Specifies the type of file the output is, if it is a known type (such as TYPE_C, TYPE_UI, TYPE_QRC) then it
is handled as one of those type of files.
input The variable that contains the files that should be processed with the custom compiler.
name A description of what the custom compiler is doing. This is only used in some backends.
output_function Specifies a custom qmake function that is used to specify the filename to be created.
variables Indicates that the variables specified here are replaced with $(QMAKE_COMP_VARNAME) when refered to
in the pro file as $(VARNAME).
variable_out The variable that the files created from the output should be added to.
combine Indicates that all of the input files are combined into a single output file.
target_predeps Indicates that the output should be added to the list ofPRE_TARGETDEPS.
explicit_dependencies The dependencies for the output only get generated from the depends member and from nowhere else.
no_link Indicates that the output should not be added to the list of objects to be linked in.
SOURCES += hello.cpp
We repeat this for each source file in the project, until we end up with the following:
SOURCES += hello.cpp
SOURCES += main.cpp
If you prefer to use a Make-like syntax, with all the files listed in one go you can use the
newline escaping like this:
SOURCES = hello.cpp \
main.cpp
Now that the source files are listed in the project file, the header files must be added. These
are added in exactly the same way as source files, except that the variable name we use
is HEADERS.
Once you have done this, your project file should look something like this:
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
The target name is set automatically; it is the same as the project file, but with the suffix
appropriate to the platform. For example, if the project file is called hello.pro, the target
will be hello.exe on Windows and hello on Unix. If you want to use a different name you
can set it in the project file:
TARGET = helloworld
CONFIG += qt
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
You can now use qmake to generate a Makefile for your application. On the command line, in
your project's directory, type the following:
CONFIG += qt debug
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
Use qmake as before to generate a Makefile and you will be able to obtain useful information
about your application when running it in a debugging environment.
Adding Platform-Specific Source Files
After a few hours of coding, you might have made a start on the platform-specific part of
your application, and decided to keep the platform-dependent code separate. So you now
have two new files to include into your project file: hellowin.cpp and hellounix.cpp. We
can't just add these to the SOURCES variable since this will put both files in the Makefile. So,
what we need to do here is to use a scope which will be processed depending on which
platform qmake is run on.
A simple scope that will add in the platform-dependent file for Windows looks like this:
win32 {
SOURCES += hellowin.cpp
So if qmake is run on Windows, it will add hellowin.cpp to the list of source files. If qmakeis
run on any other platform, it will simply ignore it. Now all that is left to be done is to create
a scope for the Unix-specific file.
When you have done that, your project file should now look something like this:
CONFIG += qt debug
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
win32 {
SOURCES += hellowin.cpp
unix {
SOURCES += hellounix.cpp
The ! symbol is used to negate the test; i.e. exists( main.cpp ) is true if the file exists,
and !exists( main.cpp ) is true if the file doesn't exist.
CONFIG += qt debug
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
win32 {
SOURCES += hellowin.cpp
unix {
SOURCES += hellounix.cpp
!exists( main.cpp ) {
win32 {
debug {
CONFIG += console
Nested scopes can be joined together using colons, so the final project file looks like this:
CONFIG += qt debug
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
win32 {
SOURCES += hellowin.cpp
unix {
SOURCES += hellounix.cpp
!exists( main.cpp ) {
win32:debug {
CONFIG += console
That's it! You have now completed the tutorial for qmake, and are ready to write project files
for your development projects.
Building an Application
The app Template
The app template tells qmake to generate a Makefile that will build an application. With this
template, the type of application can be specified by adding one of the following options to
the CONFIG variable definition:
Option Description
LEXSOURCES - A list of all the lex source files for the application.
YACCSOURCES - A list of all the yacc source files for the application.
TARGET - Name of the executable for the application. This defaults to the name of
the project file. (The extension, if any, is added automatically).
DESTDIR - The directory in which the target executable is placed.
DEFINES - A list of any additional pre-processor defines needed for the application.
INCLUDEPATH - A list of any additional include paths needed for the application.
DEPENDPATH - The dependency search path for the application.
VPATH - The search path to find supplied files.
DEF_FILE - Windows only: A .def file to be linked against for the application.
RC_FILE - Windows only: A resource file for the application.
RES_FILE - Windows only: A resource file to be linked against for the application.
You only need to use the system variables that you have values for, for instance, if you do
not have any extra INCLUDEPATHs then you do not need to specify any, qmake will add in
the default ones needed. For instance, an example project file might look like this:
TEMPLATE = app
DESTDIR = c:/helloapp
HEADERS += hello.h
SOURCES += hello.cpp
SOURCES += main.cpp
DEFINES += QT_DLL
CONFIG += qt warn_on release
For items that are single valued, e.g. the template or the destination directory, we use "=";
but for multi-valued items we use "+=" to add to the existing items of that type. Using "="
replaces the item's value with the new value, for example if we wrote DEFINES=QT_DLL, all
other definitions would be deleted.
Building a Library
plugin The library is a plugin; this also enables the dll option.
The following option can also be defined to provide additional information about the library.
VERSION - The version number of the target library, for example, 2.3.1.
The target file name for the library is platform-dependent. For example, on X11 and Mac OS
X, the library name will be prefixed by lib; on Windows, no prefix is added to the file name.
Building a Plugin
Plugins are built using the lib template, as described in the previous section. This
tellsqmake to generate a Makefile for the project that will build a plugin in a suitable form for
each platform, usually in the form of a library. As with ordinary libraries,
the VERSIONvariable is used to specify information about the plugin.
VERSION - The version number of the target library, for example, 2.3.1.
CONFIG += debug_and_release
CONFIG(debug, debug|release) {
TARGET = debug_binary
} else {
TARGET = release_binary
The scope in the above snippet modifies the build target in each mode to ensure that the
resulting targets have different names. Providing different names for targets ensures that
one will not overwrite the other.
When qmake processes the project file, it will generate a Makefile rule to allow the project to
be built in both modes. This can be invoked in the following way:
make all
CONFIG += build_all
make
It is possible to customize the names of the build targets depending on the target platform.
For example, a library or plugin may be named using a different convention on Windows to
the one used on Unix platforms:
CONFIG(debug, debug|release) {
The default behavior in the above snippet is to modify the name used for the build target
when building in debug mode. An else clause could be added to the scope to do the same
for release mode; left as it is, the target name remains unmodified.