-
Laszlo Agocs authored
And split up a long sentence. Change-Id: Idd4f1aba0154e702dba415405114f5137f0d782b Reviewed-by:
Topi Reiniö <topi.reinio@digia.com> Reviewed-by:
Nico Vertriest <nico.vertriest@digia.com>
2ea9bb43
/******************************************************************************** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).** Contact: http://www.qt-project.org/legal**** This file is part of the documentation of the Qt Toolkit.**** $QT_BEGIN_LICENSE:FDL$** Commercial License Usage** Licensees holding valid commercial Qt licenses may use this file in** accordance with the commercial license agreement provided with the** Software or, alternatively, in accordance with the terms contained in** a written agreement between you and Digia. For licensing terms and** conditions see http://qt.digia.com/licensing. For further information** use the contact form at http://qt.digia.com/contact-us.**** GNU Free Documentation License Usage** Alternatively, this file may be used under the terms of the GNU Free** Documentation License version 1.3 as published by the Free Software** Foundation and appearing in the file included in the packaging of** this file. Please review the following information to ensure** the GNU Free Documentation License version 1.3 requirements** will be met: http://www.gnu.org/copyleft/fdl.html.** $QT_END_LICENSE$******************************************************************************//*! \page windows-support.html \title Qt for Windows \brief Platform support for Windows. \ingroup supportedplatform Qt's support for different Windows platforms is extensive and mature. Before you get started, ensure that your development environment fulfills the \l{Qt for Windows Requirements}{requirements}. The \e{Reference Configuration} section of the \l{Supported Platforms} page contains the list of Windows version and the compiler tested to work with Qt. \section1 Downloading and Installing Qt There are two ways to install Qt: \list 1 \li through the Qt Installers - downloads and installs Qt \li through the \e{Qt sources}. \endlist You can download the Qt 5 installers and sources from the \l Downloads page. For more information, visit the \l{Getting Started with Qt} page. \note Qt Enterprise packages are available from the \l{Try Qt Enterprise} page. \section2 Building Qt 5 from Source You can also build Qt 5 from the source package and configure it according to your target platform. The source packages are obtained from \l{http://qt-project.org/downloads}. Below, you will find more information about building Qt from source. \list \li \l{Qt for Windows - Requirements} \li \l{Qt for Windows - Building from Source} \endlist \section1 Deployment and Other Issues The pages below covers specific issues and recommendations for creating7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
Windows applications.
\list
\li \l{Qt for Windows - Deployment}
\li \l{Qt for Windows - Specific Issues}
\endlist
\section1 Where to Go from Here
We invite you to explore the rest of Qt. We prepared overviews which help
you decide which APIs to use and our examples demonstrate how to use our
API.
\list
\li \l{Qt Overviews} - list of topics about application development
\li \l{Qt Examples and Tutorials}{Examples and Tutorials} - code samples and tutorials
\li \l{Qt Reference Pages} - a listing of C++ and QML APIs
\li \l{ActiveX in Qt}
\endlist
Qt's vibrant and active community site, \l{http://qt-project.org} houses
a wiki, a forum, and additional learning guides and presentations.
\section2 Visual Studio Add-in
The Qt Visual Studio Add-in allows programmers to create, build, debug
and run Qt applications from within non-Express versions of Microsoft Visual Studio
2008, 2010, and 2012. The add-in contains project wizards, Qt project import/export
support, integrated Qt resource manager and automated build setup for
the Qt Meta-Object Compiler, User Interface Compiler, and Resource
Compiler.
*/
/*!
\page windows-requirements.html
\title Qt for Windows - Requirements
\brief Requirements of the Windows environment.
This page describes the required libraries and environment for
\l{Qt for Windows}.
\section1 Libraries
The following libraries may be used when running Qt 5 applications in Windows.
These are not mandatory, but some components (for example, Qt WebKit) may depend
on them.
\list
\li \l{ICU}: Qt 5 can make use of the ICU library for enhanced UNICODE and Globalization
support (see QTextCodec, QCollator::setNumericMode()).
At compile time, the \e include and \e lib folders of the ICU installation must
be appended to the \c INCLUDE and \c LIB environment variables. At run-time, the ICU DLLs
need to be found by copying the DLLs to the
application folder or by adding the \e bin folder of the ICU
installation to the \c PATH environment variable.
\li \l{ANGLE}: This library converts
OpenGL ES 2.0 API calls to DirectX 9, removing the need to install
graphics drivers on the target machines. Building
the library requires the installation of the \l{Direct X SDK}.
More information is available at \l{http://code.google.com/p/angleproject/wiki/DevSetup}
\note When building for 64-bit environments, de-activate the
\c WarnAsError option in every project file, otherwise, integer
conversion warnings will break the build.
\endlist
Support for Secure Sockets Layer (SSL) communication is provided by the
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
\l {OpenSSL Toolkit}, which must be obtained separately. See
\l {Secure Sockets Layer (SSL) Classes} for instructions on building Qt with
SSL support.
\section2 ICU
Qt WebKit, and applications using it, always need the ICU libraries. Qt Core
can be configured to either rely on ICU functionality, or fall back to Windows API
and internal algorithms with somewhat reduced functionality.
From Qt 5.3 and onwards, configure does not link Qt Core against ICU libraries
anymore by default. This reduces the size of a self-contained
application package considerably, as long as Qt WebKit is not used.
Letting Qt Core utilize the ICU libraries however has following advantages:
\list
\li Behavior matches other platforms more closely.
\li Extended set of text codecs (see \l QTextCodec).
\li QLocale::toUpper(), QLocale::toLower() always use case conversion rules
specific to the locale.
\li QCollator::setNumericMode() does work consistently on all Windows versions.
\endlist
To explicitly enable the use of ICU in Qt Core, pass \c -icu to \c configure:
\code
configure -icu
\endcode
\section1 Graphics Drivers
For \l{Qt Quick} 2 to work, a graphics driver that provides OpenGL 2.1 or
higher is required. The default driver from Windows is OpenGL 1.1. Qt
includes a version of the \l{ANGLE} project which is included from the
Windows Qt installers. ANGLE implements the
OpenGL ES 2.0 API on top of DirectX 9. ANGLE requires that the DirectX SDK
is installed when building Qt.
To use a custom version of ANGLE, set the \c ANGLE_DIR environment variable
to point to the ANGLE source tree before building Qt.
If you installed additional OpenGL drivers from your hardware vendor, then
you may want to consider using this version of OpenGL instead of ANGLE. To
use OpenGL, pass the command line options \c{-opengl desktop} to the
configure script.
\code
configure -opengl desktop
\endcode
To use an OpenGL ES 2.0 emulator instead of ANGLE, use the configure
options: \c{-opengl es2 -no-angle}.
\code
configure -opengl es2 -no-angle
\endcode
\section2 Dynamically Loading Graphics Drivers
In addition to the build time configuration, Qt supports choosing
and loading the OpenGL implementation at runtime. To use this
mode, pass \c{-opengl dynamic} to the configure script.
\code
configure -opengl dynamic
\endcode
This configuration is the most flexible because no dependencies or
assumptions are hardcoded about the OpenGL implementation during build
time. It allows robust application deployment. When a given environment
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
fails to provide a proper OpenGL 2.0 implementation, it will fall back
automatically to ANGLE. This fallback will be completely transparent to the
application, and will allow Qt Quick or other OpenGL code to function by
translating to Direct3D. Such a fallback could, for example, take place on a
Windows 7 PC with no additional graphics drivers installed. On other
machines, where there is sufficient OpenGL support, the normal desktop
OpenGL drivers will be used. Additionally, pure software-based OpenGL
implementations may be available as additional fallbacks in the future,
allowing running Qt Quick applications without a GPU.
When configured with \c{-opengl dynamic}, neither Qt nor the applications
built using \c qmake will link to the opengl32 (standard desktop OpenGL) or
libGLESv2 (ANGLE) libraries. Instead, the appropriate library is chosen at
runtime. By default, Qt will determine whether the system's opengl32.dll
provides OpenGL 2 functions. If these are present, opengl32.dll is used,
otherwise the ANGLE libraries will be used. In case the ANGLE libraries are
missing or initialization fails for some reason, an additional fallback is
attempted by trying to load \c{QtSoftwareOpenGL.dll}. See below for details.
The loading mechanism can be configured through the \c{QT_OPENGL}
environment variable and the following application attributes:
\list
\li \c Qt::AA_UseDesktopOpenGL Equivalent to setting \c{QT_OPENGL} to \c{desktop}.
\li \c Qt::AA_UseOpenGLES Equivalent to setting \c{QT_OPENGL} to \c{angle}.
\li \c Qt::AA_UseSoftwareOpenGL Equivalent to setting \c{QT_OPENGL} to \c{software}.
\endlist
When a certain configuration is requested explicitly, no checks are done at
application startup, that is, the system-provided opengl32.dll will not be
examined.
The dynamic loading has a significant impact on applications that contain
native OpenGL calls: they may fail to link since \c qmake no longer
automatically adds opengl32.lib or libglesv2.lib. Instead, applications are
expected to use the OpenGL functions via the QOpenGLFunctions class. Thus
the direct dependency on the OpenGL library is removed and all calls will be
routed during runtime to the implementation chosen by Qt.
Applications that require a certain OpenGL implementation (for example,
desktop OpenGL due to relying on features provided by OpenGL 3.0 or higher)
should set the application attributes \c Qt::AA_UseOpenGLES or \c
Qt::AA_UseDesktopOpenGL before instantiating QGuiApplication or
QApplication. When these attributes are set, no other OpenGL implementations
are considered. Additionally, if they wish to, such applications are free to
make direct OpenGL function calls by adding opengl32.lib to their .pro
project files: \e{LIBS += opengl32.lib} (Visual Studio) or \e{LIBS +=
-lopengl32} (MinGW). The result is, from the application's perspective,
equivalent to the \c{-opengl desktop} build configuration of Qt.
\c Qt::AA_UseSoftwareOpenGL is special in the sense that it will try to load
an OpenGL implementation with a non-standard name. The default name is
\c{QtSoftwareOpenGL.dll}. This allows shipping a software-only OpenGL
implementation, for example a build of
\l{http://www.mesa3d.org/llvmpipe.html}{Mesa with llvmpipe}, under this
name. If necessary, the filename can be overridden by setting the
\c{QT_OPENGL_DLL} environment variable.
\section1 Building from Source
These tools are not needed to run Qt 5 applications, but they are required
for building Qt 5 from source.
\list
\li \l ActivePerl - Install a recent version of ActivePerl
(\l{http://www.activestate.com/activeperl}{download page}) and add
the installation location to your \c PATH.
\li Python - Install Python from the \l{http://www.python.org/download/}{here}
and add the installation location to your PATH in order to be able
to build Qt WebKit.
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
\li Install \l{http://www.ruby-lang.org}{Ruby} from \l{http://rubyinstaller.org/}{here}
and add the installation location to your PATH in order to be able
to build Qt WebKit.
\endlist
\note Please make sure that the \c perl executable from ActivePerl is found
in the path before the perl executable provided by msysgit, since the
latter is outdated.
Qt WebKit and ANGLE depend on these extra tools from the \l{GnuWin32
Project} which are provided for your convenience in the \e gnuwin32/bin
folder:
\list
\li \l{http://gnuwin32.sourceforge.net/downlinks/bison.php}{Bison}
\li \l{http://gnuwin32.sourceforge.net/downlinks/gperf.php}{GPerf}
\li \l{http://gnuwin32.sourceforge.net/downlinks/flex.php}{Flex}
\endlist
The \e gnuwin32/bin folder should be added to the \c PATH variable.
For instructions for building the Qt 5 source,read
the \l{Qt for Windows - Building from Source} page.
\section1 SDKs and Compilers
A Windows SDK is required to develop Qt applications on Windows.
\list
\li Windows SDK 8 (with Visual Studio 2012 Express).
As of Windows 8, the SDK no longer ships with a complete command-line build environment.
You must install a compiler and build environment separately. If you require a
complete development environment that includes compilers and a build environment,
you can download Visual Studio 2012 Express, which includes the appropriate
components of the Windows SDK.
(\l{http://msdn.microsoft.com/en-us/windows/desktop/hh852363.aspx}{Download page})
\li Windows SDK 7.1.
Note that, as of 16.3.2012, if you use this SDK with Visual Studio 2010,
installing the SDK requires installing the following packages
in this order (see \e readme.html provided with the service pack):
\list 1
\li Install Visual Studio 2010
\li Install Windows SDK 7.1
\li Install Visual Studio 2010 SP1
\li Install Visual C++ 2010 SP1 Compiler Update for the Windows SDK 7.1
\endlist
\li Windows SDK 7.
\li A MinGW toolchain with g++ version 4.7 or higher. Qt 5 is tested regularly with a \
\l{http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/4.8.0/32-bit/threads-posix/dwarf/x32-4.8.0-release-posix-dwarf-rev1.7z}
{32 bit gcc 4.8.0 toolchain} from the \l{http://mingwbuilds.sourceforge.net}{MinGW-builds}
project.
\endlist
For the most up to date information about the \l{Qt WebKit} dependencies,
please refer to the \l{http://trac.webkit.org/wiki/BuildingQtOnWindows}{Qt WebKit Wiki for Windows}.
*/
/*!
\page windows-issues.html
\title Qt for Windows - Specific Issues
\brief A description of issues with Qt that are specific to Windows.
This page contains information about the \l{Qt for Windows}{Windows}
platforms Qt.
\section1 Windows XP
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
\section2 Installation location
Installing Qt into a directory with spaces, for example,
\e{C:\\Program Files}, may cause linker errors like the following:
\snippet snippets/code/doc_src_platform-notes.qdoc 2
Install Qt into a sub-directory without spaces to avoid this problem.
\section2 Possible GL conflict
There is a known issue when running Microsoft NetMeeting, Lotus SameTime,
and other applications that require screen grabbing while direct
rendering is enabled. Other GL-applications may not work as expected,
unless direct rendering is disabled.
\section2 GCC (MinGW-builds)
The minimum version of MinGW-builds supported is GCC 4.7.2.
\l{http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/4.7.2/32-bit/threads-posix/sjlj/x32-4.7.2-release-posix-sjlj-rev8.7z}
{MinGW-builds GCC 4.7.2 32 bit, rev 8} and later should be able
to build Qt including Qt WebKit.
For more information about the MinGW builds, visit the
\e{Reference Configuration} section of the \l{Supported Platforms} page.
\section2 Intel C++ Compiler (Windows, Altix)
Qt has been tested successfully with:
\list
\li Windows - Intel(R) C++ Compiler for 32-bit applications,
Version 9.1.040.
\li Altix - Intel(R) C++ Itanium(R) Compiler for Itanium(R)-based
applications Version 8.1 Build 20050406 Package ID: l_cc_pc_8.1.030
\endlist
\section2 Visual Studio
The Visual C++ Linker doesn't understand filenames with spaces (for example,
\e{C:\\Program files\\Qt\\}) so you will have to move it to another place,
or explicitly set the path yourself.
\snippet snippets/code/doc_src_compiler-notes.qdoc 0
If you are experiencing strange problems with using special flags that
modify the alignment of structure and union members (such as \c{/Zp2})
then you will need to recompile Qt with the flags set for the
application as well.
Visual Studio 2010 should be updated to Service Pack 1. Otherwise, a
problem when compiling Qt for 64-bit in release mode may occur (visit
\l{http://support.microsoft.com/kb/2280741}).
Consult the \l{Qt for Windows - Requirements} page for specific versions
of the Windows SDK.
*/
/*!
\page windows-deployment.html
\title Qt for Windows - Deployment
This documentation describes deployment issues for \l{Qt for
Windows}{Windows}. We demonstrate the procedures in terms of
deploying the \l {tools/plugandpaint}{Plug & Paint} application that is
provided in Qt's examples directory.
\section1 Static Linking
To build static applications, build Qt statically by configuring Qt with
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
\c -static:
\snippet snippets/code/doc_src_deployment.qdoc 11
If you later need to reconfigure and rebuild Qt from the
same location, ensure that all traces of the previous configuration are
removed by entering the build directory and running \c{nmake distclean} or
\c{mingw32-make distclean} before running \c configure again.
\section2 Linking the Application to the Static Version of Qt
As an example, this section will build the \l{tools/plugandpaint}{Plug & Paint}
example statically.
Once Qt finishes building, build the \l{tools/plugandpaint}{Plug & Paint}
application. First we must go into the directory that contains the
application:
\snippet snippets/code/doc_src_deployment.qdoc 13
Run \c qmake to create a new makefile for the
application, and perform a clean build to create the statically linked
executable:
\snippet snippets/code/doc_src_deployment.qdoc 14
You probably want to link against the release libraries, and you can specify
this when invoking \c qmake. Now, provided that everything compiled and
linked without any errors, we should have a \c plugandpaint.exe file that is
ready for deployment. To check that the application has the required
libraries, copy the executable to a machine that does not have Qt or any Qt
applications installed, and run it on that machine.
Remember that if your application depends on compiler specific
libraries, these must still be redistributed along with your
application. You can check which libraries your application is
linking against by using the \c depends tool. For more
information, read the \l {Application Dependencies} section.
Since we cannot deploy plugins using the static linking
approach, the application we have prepared is incomplete. It will
run, but the functionality will be disabled due to the missing
plugins. To deploy plugin-based applications we should use the
shared library approach.
\section1 Shared Libraries
We have two challenges when deploying the \l
{tools/plugandpaint}{Plug & Paint} application using the shared
libraries approach: The Qt runtime has to be correctly
redistributed along with the application executable, and the
plugins have to be installed in the correct location on the target
system so that the application can find them.
\section2 Building Qt as a Shared Library
For this example, we assume that Qt is installed as a shared library,
which is the default when installing Qt, in the \e{C:\\path\\to\\Qt}
directory.
\section2 Linking the Application to Qt as a Shared Library
After ensuring that Qt is built as a shared library, we can build
the \l {tools/plugandpaint}{Plug & Paint} application. First, we
must go into the directory that contains the application:
\snippet snippets/code/doc_src_deployment.qdoc 15
Now run \c qmake to create a new makefile for the application, and
do a clean build to create the dynamically linked executable:
491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
\snippet snippets/code/doc_src_deployment.qdoc 16
This builds the core application, the following will build the
plugins:
\snippet snippets/code/doc_src_deployment.qdoc 17
If everything compiled and linked without any errors, we will get
a \c plugandpaint.exe executable and the \c pnp_basictools.dll and
\c pnp_extrafilters.dll plugin files.
\section2 Creating the Application Package
To deploy the application, we must make sure that we copy the
relevant Qt DLLs (corresponding to the Qt modules used in
the application) and the Windows platform plugin, \c {qwindows.dll},
as well as the executable to the same directory tree in the \c release
subdirectory.
In contrast to user plugins, Qt plugins have to be put into subdirectories
matching the plugin type. The correct location for the platform plugin
is a subdirectory named \c {platforms}. \l{Qt Plugins} section has
additional information about plugins and how Qt searches for them.
Qt relies on the \l{ICU} library for unicode support. Therefore, you must
include the ICU DLLs that are located in the \c bin directory of your Qt
installation if Qt was configured to use ICU. The Qt version bundled in
the Qt5 package uses ICU, so deployment is needed there. The ICU DLLs are
version dependent and have to match the ones your Qt version was linked
against.
If you are using \l{ANGLE} (the default) then you additionally
need to include both libEGL.dll and libGLESv2.dll from Qt's 'lib'
directory as well as the HLSL compiler from DirectX. The HLSL
compiler library is called d3dcompiler_XX.dll where XX is the
version number that ANGLE (libGLESv2) was linked against.
Remember that if your application depends on compiler specific
libraries, these must be redistributed along with your
application. You can check which libraries your application is
linking against by using the \c depends tool. For more
information, see the \l {Application Dependencies} section.
We'll cover the plugins shortly, but first we'll check that the
application will work in a deployed environment: Either copy the
executable and the Qt DLLs to a machine that doesn't have Qt
or any Qt applications installed, or if you want to test on the
build machine, ensure that the machine doesn't have Qt in its
environment.
If the application starts without any problems, then we have
successfully made a dynamically linked version of the \l
{tools/plugandpaint}{Plug & Paint} application. But the
application's functionality will still be missing since we have
not yet deployed the associated plugins.
Plugins work differently to normal DLLs, so we can't just
copy them into the same directory as our application's executable
as we did with the Qt DLLs. When looking for plugins, the
application searches in a \c plugins subdirectory inside the
directory of the application executable.
So to make the plugins available to our application, we have to
create the \c plugins subdirectory and copy over the relevant DLLs:
\snippet snippets/code/doc_src_deployment.qdoc 18
An archive distributing all the Qt DLLs and application
specific plugins required to run the \l {tools/plugandpaint}{Plug
561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
& Paint} application, would have to include the following files:
\table 100%
\header
\li Component \li {2, 1} File Name
\row
\li The executable
\li {2, 1} \c plugandpaint.exe
\row
\li The Basic Tools plugin
\li {2, 1} \c plugins\pnp_basictools.dll
\row
\li The ExtraFilters plugin
\li {2, 1} \c plugins\pnp_extrafilters.dll
\row
\li The Qt Windows platform plugin
\li {2, 1} \c platforms\qwindows.dll
\row
\li The Qt Core module
\li {2, 1} \c Qt5Core.dll
\row
\li The Qt GUI module
\li {2, 1} \c Qt5Gui.dll
\row
\li The Qt Widgets module
\li {2, 1} \c Qt5Widgets.dll
\endtable
In addition, the archive must contain the following compiler
specific libraries depending on your version of Visual Studio:
\table 100%
\header
\li \li VC++ 8.0 (2005) \li VC++ 9.0 (2008) \li VC++ 10.0 (2010)
\row
\li The C run-time
\li \c msvcr80.dll
\li \c msvcr90.dll
\li \c msvcr100.dll
\row
\li The C++ run-time
\li \c msvcp80.dll
\li \c msvcp90.dll
\li \c msvcp100.dll
\endtable
If ICU was used, the archive must contain:
\table 100%
\header
\li{3,1} File Name
\row
\li icudtXX.dll
\li icuinXX.dll
\li icuucXX.dll
\endtable
Finally, if ANGLE was used, then the archive must additionally
contain:
\table 100%
\header
\li{3,1} File Name
\row
\li libEGL.dll
\li libGLESv2.dll
\li d3dcompiler_XX.dll
\endtable
To verify that the application now can be successfully deployed,
631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
you can extract this archive on a machine without Qt and without
any compiler installed, and try to run it.
An alternative to putting the plugins in the plugins subdirectory
is to add a custom search path when you start your application
using QApplication::addLibraryPath() or
QApplication::setLibraryPaths().
\snippet snippets/code/doc_src_deployment.cpp 19
One benefit of using plugins is that they can easily be made
available to a whole family of applications.
It's often most convenient to add the path in the application's \c
main() function, right after the QApplication object is
created. Once the path is added, the application will search it
for plugins, in addition to looking in the \c plugins subdirectory
in the application's own directory. Any number of additional paths
can be added.
\section2 Manifest files
When deploying an application compiled with Visual Studio 2005 onwards,
there are some additional steps to be taken.
First, we need to copy the manifest file created when linking the
application. This manifest file contains information about the
application's dependencies on side-by-side assemblies, such as the runtime
libraries.
The manifest file needs to be copied into the \b same folder as the
application executable. You do not need to copy the manifest files for
shared libraries (DLLs), since they are not used.
If the shared library has dependencies that are different from the
application using it, the manifest file needs to be embedded into the DLL
binary. Since Qt 4.1.3, the following \c CONFIG options are available for
embedding manifests:
\snippet snippets/code/doc_src_deployment.qdoc 20
To use the options, add
\snippet snippets/code/doc_src_deployment.pro 21
to your .pro file. The \c embed_manifest_dll option is enabled by default.
The \c embed_manifest_exe option is NOT enabled by default.
You can find more information about manifest files and side-by-side
assemblies at the
\l {http://msdn.microsoft.com/en-us/library/aa376307.aspx}{MSDN website}.
The correct way to include the runtime libraries with your application
is to ensure that they are installed on the end-user's system.
To install the runtime libraries on the end-user's system, you need to
include the appropriate Visual C++ Redistributable Package (VCRedist)
executable with your application and ensure that it is executed when the
user installs your application.
For example, on an 32-bit x86-based system, you would include the
\l{http://www.microsoft.com/downloads/details.aspx?FamilyId=32BC1BEE-A3F9-4C13-9C99-220B62A191EE}{vcredist_x86.exe}
executable. The \l{http://www.microsoft.com/downloads/details.aspx?familyid=526BF4A7-44E6-4A91-B328-A4594ADB70E5}{vcredist_IA64.exe}
and \l{http://www.microsoft.com/downloads/details.aspx?familyid=90548130-4468-4BBC-9673-D6ACABD5D13B}{vcredist_x64.exe}
executables provide the appropriate libraries for the IA64 and 64-bit x86
architectures, respectively.
\note The application you ship must be compiled with exactly the same
compiler version against the same C runtime version. This prevents
deploying errors caused by different versions of the C runtime libraries.
701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
\section2 Manual installations with Visual Studio 2008 and 2010
As well as the above details for VS 2005 and onwards, Visual Studio 2008/2010
applications may have problems when deploying manually, say to a USB
stick.
The recommended procedure is to configure Qt with the \c -plugin-manifests
option using the 'configure' tool. Then follow the \l {http://msdn.microsoft.com/en-us/library/ms235291(VS.80).aspx}{guidelines}
for manually deploying private assemblies.
In brief the steps are
\list 1
\li create a folder structure on the development computer that will match the target USB stick directory structure, for example '\\app' and for your dlls, '\\app\\lib'.
\li on the development computer, from the appropriate 'redist' folder copy over Microsoft.VC80.CRT and Microsoft.VC80.MFC to the directories '\\app' and '\\app\\lib' on the development PC.
\li xcopy the \\app folder to the target USB stick.
\endlist
Your application should now run. Also be aware that even with a service
pack installed the Windows DLLs that are linked to will be the defaults. See
the information on \l {http://msdn.microsoft.com/en-us/library/cc664727.aspx}{how to select the appropriate target DLLs}.
\section1 Application Dependencies
\section2 Additional Libraries
Depending on configuration, compiler specific libraries must be
redistributed along with your application.
For example, if Qt is built using \l{ANGLE}, its shared libraries
and the required shared libraries of the \l{Direct X SDK} need to
be shipped as well.
You can check which
libraries your application is linking against by using the
\l{Dependency Walker} tool. All you need to do is to run it like
this:
\snippet snippets/code/doc_src_deployment.qdoc 24
This will provide a list of the libraries that your application
depends on and other information.
\image deployment-windows-depends.png
When looking at the release build of the Plug & Paint executable
(\c plugandpaint.exe) with the \c depends tool, the tool lists the
following immediate dependencies to non-system libraries:
\table 100%
\header
\li Qt
\li VC++ 8.0 (2005)
\li VC++ 9.0 (2008)
\li VC++ 10.0 (2010)
\li MinGW
\row
\li \list
\li QT5CORE.DLL - The QtCore runtime
\li QT5GUI.DLL - The QtGui runtime
\li QT5WIDGETS.DLL - The QtWidgets runtime
\endlist
\li \list
\li MSVCR80.DLL - The C runtime
\li MSVCP80.DLL - The C++ runtime
\endlist
771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840
\li \list
\li MSVCR90.DLL - The C runtime
\li MSVCP90.DLL - The C++ runtime
\endlist
\li \list
\li MSVCR100.DLL - The C runtime
\li MSVCP100.DLL - The C++ runtime
\endlist
\li \list
\li MINGWM10.DLL - The MinGW run-time
\li LIBGCC_S_DW2-1.DLL
\li LIBSTDC++-6.dll
\endlist
\endtable
When looking at the plugin DLLs the exact same dependencies
are listed.
\section2 Qt Plugins
All Qt GUI applications require a plugin that implements the \l {Qt
Platform Abstraction} (QPA) layer in Qt 5. For Windows, the name of the
platform plugin is \c {qwindows.dll}. This file must be located within a
specific subdirectory (by default, \c platforms) under your distribution
directory. Alternatively, it is possible to adjust the search path Qt
uses to find its plugins, as described below.
Your application may also depend on one or more Qt plugins, such
as the print support plugin, the JPEG image format plugin or a SQL driver
plugin. Be sure to distribute any Qt plugins that you need with your
application. Similar to the platform plugin, each type of plugin must
be located within a specific subdirectory (such as \c printsupport,
\c imageformats or \c sqldrivers) within your distribution directory.
\note If you are deploying an application that uses Qt WebKit to display
HTML pages from the World Wide Web, you should include all text codec
plugins to support as many HTML encodings possible.
The search path for Qt plugins is hard-coded into the QtCore library.
By default, the plugins subdirectory of the Qt installation is the first
plugin search path. However, pre-determined paths like the default one
have certain disadvantages. For example, they may not exist on the target
machine. For that reason, you need to examine various alternatives to make
sure that the Qt plugins are found:
\list
\li \l{qt-conf.html}{Using \c qt.conf}. This approach is the recommended
if you have executables in different places sharing the same plugins.
\li Using QApplication::addLibraryPath() or
QApplication::setLibraryPaths(). This approach is recommended if you only
have one executable that will use the plugin.
\li Using a third party installation utility to change the
hard-coded paths in the QtCore library.
\endlist
If you add a custom path using QApplication::addLibraryPath it could
look like this:
\snippet snippets/code/doc_src_deployment.qdoc 54
Then qApp->libraryPaths() would return something like this:
\list
\li \c{C:/customPath/plugins}
\li \c{C:/Qt/%VERSION%/plugins}
\li \c{E:/myApplication/directory}
841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910
\endlist
The executable will look for the plugins in these directories and
the same order as the QStringList returned by qApp->libraryPaths().
The newly added path is prepended to the qApp->libraryPaths() which
means that it will be searched through first. However, if you use
qApp->setLibraryPaths(), you will be able to determine which paths
and in which order they will be searched.
The \l{How to Create Qt Plugins} document outlines the issues you
need to pay attention to when building and deploying plugins for
Qt applications.
\section1 The Windows Deployment Tool
\target windeployqt
The Windows deployment tool can be found in QTDIR/bin/windeployqt. It is
designed to automate the process of creating a deployable folder that contains
all libraries, QML imports, plugins, translations that are required to run the application
from that folder. This is used to create the sandbox for \l{Qt for WinRT}{Windows Runtime}
or an installation tree for Windows desktop applications that can be easily bundled by an installer.
\badcode
Usage: windeployqt [options] [file]
Qt Deploy Tool 5.3.0
The simplest way to use windeployqt is to add the bin directory of your Qt
installation (e.g. <QT_DIR\bin>) to the PATH variable and then run:
windeployqt <path-to-app-binary>
If ICU, ANGLE, etc. are not in the bin directory, they need to be in the PATH
variable. If your application uses Qt Quick, run:
windeployqt --qmldir <path-to-app-qml-files> <path-to-app-binary>
Options:
-?, -h, --help Displays this help.
-v, --version Displays version information.
--dir <directory> Use directory instead of binary directory.
--libdir <path> Copy libraries to path.
--debug Assume debug binaries.
--release Assume release binaries.
--force Force updating files.
--dry-run Simulation mode. Behave normally, but do not
copy/update any files.
--no-plugins Skip plugin deployment.
--no-libraries Skip library deployment.
--qmldir <directory> Scan for QML-imports starting from directory.
--no-quick-import Skip deployment of Qt Quick imports.
--no-translations Skip deployment of translations.
--no-system-d3d-compiler Skip deployment of the system D3D compiler.
--compiler-runtime Deploy compiler runtime (Desktop only).
--no-compiler-runtime Do not deploy compiler runtime (Desktop only).
--webkit2 Deployment of WebKit2 (web process).
--no-webkit2 Skip deployment of WebKit2.
--json Print to stdout in JSON format.
--list <option> Print only the names of the files copied.
Available options:
source: absolute path of the source files
target: absolute path of the target files
relative: paths of the target files, relative
to the target directory
mapping: outputs the source and the relative
target, suitable for use within an
Appx mapping file
--verbose <level> Verbose level.
Qt libraries can be added by passing their name (-xml) or removed by passing
the name prepended by --no- (--no-xml). Available libraries:
bluetooth clucene concurrent core declarative designercomponents designer gui
clucene qthelp multimedia multimediawidgets multimediaquick network nfc opengl
positioning printsupport qml quick quickparticles script scripttools sensors
serialport sql svg test widgets winextras xml xmlpatterns
911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980
Arguments:
[file] Binary or directory containing the binary.
\endcode
*/
/*!
\page windows-building.html
\title Qt for Windows - Building from Source
\brief Configuring and building Qt for Windows.
This page describes the process of configuring and building
\l{Qt for Windows}. Before building, there are some requirements that are
given in more detail in the \l{Qt for Windows - Requirements} document.
You can download the Qt 5 sources from the \l{Downloads} page. For
more information, visit the \l{Getting Started with Qt} page.
\section1 Step 1: Install the License File (commercial editions only)
If you have the commercial edition of Qt, copy the license file
from your account on the distribution server into your home directory
(this may be known as the \c userprofile environment variable) and
rename it to \c{.qt-license}. This renaming process must be done
using a \e{command prompt} on Windows, \b{not} with Windows Explorer.
For example on Windows 2000, \c{%USERPROFILE%} should be something
like \c{C:\Documents and Settings\username}
For the open source version you do not need a license file.
\section1 Step 2: Unpack the Archive
Uncompress the files into the directory you want Qt installed;
e.g. \c{C:\Qt\%VERSION%}.
\note The install path must not contain any spaces or Windows specific
file system characters.
\section1 Step 3: Set the Environment variables
We recommend creating a desktop link that opens a command
prompt with the environment set up similar to the
\uicontrol{Command Prompt} menu entries provided by the Windows SDKs.
This is done by creating an application link passing a \c .cmd file setting
up the environment and the command line option \c /k (remain open)
to \c cmd.exe.
Assuming the file is called \c{qt5vars.cmd}
and the Qt folder is called \c qt-5 and located under \c C:\qt:
\code
REM Set up \Microsoft Visual Studio 2013, where <arch> is \c amd64, \c x86, etc.
CALL "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" <arch>
SET _ROOT=C:\qt\qt-5
SET PATH=%_ROOT%\qtbase\bin;%_ROOT%\gnuwin32\bin;%PATH%
REM Uncomment the below line when using a git checkout of the source repository
REM SET PATH=%_ROOT%\qtrepotools\bin;%PATH%
SET QMAKESPEC=win32-msvc2013
SET _ROOT=
\endcode
A desktop link can then be created by specifying the command
\c{%SystemRoot%\system32\cmd.exe /E:ON /V:ON /k c:\qt\qt5vars.cmd}
as application and \c{c:\qt\qt-5} as working directory.
\note Setups for MinGW are similar; they differ
only in that the \c bin folder of the installation should be added to the
path instead of calling the Windows SDK setup script. For MinGW, please make
9819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036
sure that no \c sh.exe can be found in the path, as it affects \c {mingw32-make}.
Settings required by the additional libraries (see \l{Qt for Windows Requirements})
should also go this file below the call to the Windows SDK setup script.
\section1 Step 4: Build the Qt Library
The default behavior of configure is to create an in-source build
of Qt 5. If you want to install Qt 5 to a separate location,
you need to specify the command line option \c{-prefix <location>}.
Alternatively, the command line option \c -developer-build creates
an in-source build for developer usage.
To configure the Qt library for a debug build for your machine, type
the following command in the command prompt:
\code
configure -debug -nomake examples -opensource
\endcode
The \l{Qt Configure Options}{Configure Options} page contains more
information about the configure options.
To build Qt using \l{jom}, type:
\code
jom
\endcode
If you do not have \l{jom} installed, type:
\code
nmake
\endcode
For MinGW, type:
\code
mingw32-make
\endcode
If an installation prefix was given, type
\c{jom install}, \c{nmake install} or \c{mingw32-make install}.
\note If you later need to reconfigure and rebuild Qt from the
same location, ensure that all traces of the previous configuration are
removed by entering the build directory and typing \c{nmake distclean}
before running \c configure again.
\section1 Parallel Builds
\l{jom} is a replacement for \c nmake which makes use of all CPU cores
and thus speeds up building.
*/