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
201
202
203
204
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of the Qt Build Suite.
**
** 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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/*!
\contentspage index.html
\page nsis-module.html
\ingroup list-of-modules
\title Module nsis
\brief Provides Nullsoft Scriptable Install System support.
The \c nsis module contains properties and rules for building EXE installers
for Windows using the Nullsoft Scriptable Install System.
This module is available on all platforms.
\note A typical NSIS script includes an OutFile command to set the filename of the generated
installer executable. However, \QBS overrides any OutFile commands found in the script, and
therefore, you must use the targetName property to set the filename.
\section1 General Properties
\section2 defines
\table
\row \li \b{Type:} \li \c{stringList}
\row \li \b{Default:} \li \c{undefined}
\endtable
List of preprocessor macros that get passed to the compiler.
To set macro values, use the following syntax:
\code
cpp.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"']
\endcode
\section2 disableConfig
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{false}
\endtable
Whether to disable inclusion of nsisconf.nsh. Generally you do not need to set this property.
\section2 enableQbsDefines
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{true}
\endtable
Whether to define preprocessor macros corresponding to values from the project and product
objects. When building a 64-bit package, the preprocessor variable \c{Win64} will also be
defined.
\section2 warningLevel
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Allowed Values:} \li \c{"none"}, \c{"normal"}, \c{"errors"},
\c{"warnings"}, \c{"info"}, \c{"all"}
\row \li \b{Default:} \li \c{"normal"}
\endtable
Severity of warnings to emit. The higher the level, the more warnings will be shown.
The levels \c{none}, \c{errors}, \c{warnings}, \c{info} and \c{all} correspond to NSIS
verbosity levels 0 through 4, inclusive. \c{normal} corresponds to the default level.
\section2 compilerFlags
\table
\row \li \b{Type:} \li \c{stringList}
\row \li \b{Default:} \li undefined
\endtable
Additional flags for the NSIS compiler.
\section2 compressor
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Allowed Values:} \li \c{"default"},
\c{"zlib"}, \c{"zlib-solid"},
\c{"bzip2"}, \c{"bzip2-solid"},
\c{"lzma"}, \c{"lzma-solid"}
\row \li \b{Default:} \li \c{"default"}
\row
\endtable
Compression algorithm used to compress files and data in the installer.
Setting this property overrides any SetCompressor command in the NSI file being compiled.
\section2 version
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{undefined}
\endtable
The NSIS version. Consists of four numbers separated by dots, for instance "2.46.0.0".
\section2 versionMajor
\table
\row \li \b{Type:} \li \c{int}
\row \li \b{Default:} \li \c{versionParts[0]}
\endtable
The NSIS major version.
\section2 versionMinor
\table
\row \li \b{Type:} \li \c{int}
\row \li \b{Default:} \li \c{versionParts[1]}
\endtable
The NSIS minor version.
\section2 versionParts
\table
\row \li \b{Type:} \li \c{list}
\row \li \b{Default:} \li \c{empty}
\endtable
The NSIS version as a list. For instance, NSIS version 2.46.0.0 would correspond to a value of
\c[2, 46, 0, 0].
\section2 versionPatch
\table
\row \li \b{Type:} \li \c{int}
\row \li \b{Default:} \li \c{versionParts[2]}
\endtable
The NSIS patch level.
\section2 versionBuild
\table
\row \li \b{Type:} \li \c{int}
\row \li \b{Default:} \li \c{versionParts[3]}
\endtable
The fourth NSIS version number component.
\section2 toolchainInstallPath
\table
\row \li \b{Type:} \li \c{path}
\row \li \b{Default:} \li determined automatically
\endtable
NSIS installation directory. Determined by searching known registry keys and
known installation paths until a match is found.
This should not normally need to be changed.
\section2 compilerName
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{"makensis"}
\endtable
Name of the compiler binary. This should not normally need to be changed.
\section2 compilerPath
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{compilerName}
\endtable
Directory where the compiler binary is located. This should not normally need to be changed.
*/
|
