1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\previouspage ifw-overview.html
\page ifw-getting-started.html
\nextpage ifw-use-cases.html
\title Getting Started
Qt Installer Framework is developed as part of the Qt project. The
framework itself uses Qt. However, it can be used to install all kind of
applications, including (but not limited to) applications built with Qt.
\section1 Supported Platforms
You can use the Qt Installer Framework to create installers for all
platforms supported by \l[QtDoc]{Supported Platforms}{desktop Qt}.
The installers have been tested on the following platforms:
\list
\li Microsoft Windows 7, and later
\li Ubuntu Linux 18.04, and later
\li macOS 10.13, and later
\endlist
\section1 Building from Sources
The following steps describe how to build the Qt Installer Framework
yourself. You can skip this if you have downloaded a pre-built version
of the framework.
\section2 Supported Compilers
The Qt Installer Framework can be compiled with Microsoft Visual Studio
2015 and newer, GCC 5 and newer, and Clang 11.0.0 and newer. Currently, the
tested combination for Windows is Qt 5.15.2 with MSVC 2015 (Windows 10).
\section2 Configuring Qt
If you use a statically built Qt to build the Qt Installer Framework
you do not have to deliver Qt libraries, which enables you to distribute
installers as one file. Please read SSL Import and Export Restrictions
from http://doc.qt.io/qt-5/ssl.html if you are statically linking against
OpenSSL libraries.
The supported Qt version is 5.15.2.
\section3 Configuring Qt for Windows
We recommend that you use the following options when you configure Qt for
Windows:
\code
configure -prefix %CD%\qtbase -release -static -static-runtime -accessibility -no-icu -no-sql-sqlite -no-qml-debug -nomake examples -nomake tests
\endcode
Build Qt:
\code
nmake (or 'mingw32-make') module-qtbase module-qtdeclarative module-qttools module-qttranslations module-qtwinextras
\endcode
\section3 Configuring Qt for Linux
We recommend that you use the following configuration options for Linux:
\code
configure -prefix $PWD/qtbase -release -static -accessibility -qt-zlib -qt-libpng -qt-libjpeg -qt-pcre -no-glib -no-cups -no-sql-sqlite -no-qml-debug -no-opengl -no-egl -no-xinput2 -no-sm -no-icu -nomake examples -nomake tests -no-libudev
\endcode
Build Qt:
\code
make module-qtbase module-qtdeclarative module-qttools module-qttranslations
\endcode
\section3 Configuring Qt for macOS
We recommend that you use the following configuration options for macOS:
\code
configure -prefix $PWD/qtbase -release -static -no-securetransport -accessibility -qt-zlib -qt-libpng -qt-libjpeg -no-cups -no-sql-sqlite -no-qml-debug -nomake examples -nomake tests -no-freetype
\endcode
Build Qt:
\code
make module-qtbase module-qtdeclarative module-qttools module-qttranslations
\endcode
\section2 Third Party Dependencies
The Qt Installer Framework sources contain a redistribution of parts of the
libarchive compression and archive library, which requires you to link against
additional libraries; \c liblzma, \c zlib, \c libbzip2, and on macOS, \c libiconv.
The usage of libarchive is recommended and can be enabled by adding the libarchive
configuration feature to the list of values specified by the \c CONFIG variable. Installers
created with this configuration support the (de)compression of 7zip, zip, and tar archive
files, with gzip, bzip2, and xz as available compression methods.
\code
qmake CONFIG+=libarchive
\endcode
The \c IFW_ZLIB_LIBRARY, \c IFW_BZIP2_LIBRARY, \c IFW_LZMA_LIBRARY, and \c IFW_ICONV_LIBRARY
variables can be used to specify the exact library files if required.
If you omit the feature, the builtin LZMA SDK library will be used as a fallback and
installation of the additional dependencies can be skipped, but created installers will
only support the 7zip format.
\note Building IFW with LZMA SDK is deprecated and may not be available in future versions.
\section3 Installing Dependencies for Windows
The source archives for the dependencies can be downloaded from:
\list
\li \l https://tukaani.org/xz/
\li \l https://zlib.net/
\li \l https://www.sourceware.org/bzip2/
\endlist
When building the third party libraries with MSVC, make sure to use the
same version that you used to build Qt, and that the compiler option used
to select the run-time library matches the configuration options for Qt
(debug/release, static/dynamic runtime).
\section3 Installing Dependencies for Linux
The required third party compression libraries are likely available from
your distribution's package manager repositories.
For example, on Ubuntu 18.04 you can invoke the following to install the
development packages containing headers for the libraries:
\code
sudo apt install zlib1g-dev liblzma-dev libbz2-dev
\endcode
\section3 Installing Dependencies for macOS
The easiest way to install the missing libraries is with a third party
package manager solution, like Homebrew or MacPorts. On macOS 10.15 you
should only need to additionally install the liblzma library.
On Homebrew this would be:
\code
brew install xz
\endcode
\section3 Troubleshooting
For libarchive related compilation errors, you may need to edit the definitions in
a configuration header file respective to your platform, which can be found from the
'src/libs/3rdparty/libarchive/config/' directory of the Installer Framework sources.
\section2 Setting up Qt Installer Framework
\list 1
\li Clone the Qt Installer Framework source code from
\l{http://code.qt.io/cgit/installer-framework/installer-framework.git/}
to get the sources for the tools.
\li Build the tools by running the "qmake" from the static Qt, followed by "make" or "nmake".
\endlist
\note To contribute patches to Qt Installer Framework, follow the standard
Qt processes and guidelines. For more information, see
\l{http://wiki.qt.io/Contribute}{Contribute to Qt}.
*/
|
