summaryrefslogtreecommitdiffstats
path: root/doc/installerfw.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/installerfw.qdoc')
-rw-r--r--doc/installerfw.qdoc43
1 files changed, 39 insertions, 4 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 94659711a..cc15efb36 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -217,13 +217,18 @@
\li WizardStyle
\li Set the wizard style to be used ("Modern", "Mac", "Aero" or "Classic").
\row
+ \li StyleSheet
+ \li Set the stylesheet file.
+ \row
\li WizardDefaultWidth
\li Sets the default width of the wizard in pixels. Setting a banner image will
- override this.
+ override this. You can add the \c em or \c ex suffix to the specified value to
+ use the \e em or \e ex unit, as in a CSS file.
\row
\li WizardDefaultHeight
\li Sets the default height of the wizard in pixels. Setting a watermark image will
- override this.
+ override this. You can add the \c em or \c ex suffix to the specified value to
+ use the \e em or \e ex unit, as in a CSS file.
\row
\li TitleColor
\li Set the color of the titles and subtitles (takes an HTML color code,
@@ -277,6 +282,10 @@
\li Set to \c true if the installation path can contain non-ASCII
characters.
\row
+ \li DisableAuthorizationFallback
+ \li Set to \c true if the installation should not ask users to run the authorization
+ fallback in case of authorization errors. Instead abort the installation immediately.
+ \row
\li RepositorySettingsPageVisible
\li Set to \c false to hide the repository settings page inside the settings dialog.
\row
@@ -307,6 +316,14 @@
\li Set to \c true if you want to create a local repository inside the installation directory.
This option has no effect on online installers. The repository will be automatically added
to the list of default repositories.
+ \row
+ \li InstallActionColumnVisible
+ \li Set to \c true if you want to add an extra column into component tree showing install actions.
+ This extra column indicates whether a component is going to be installed or uninstalled,
+ or just stay installed or uninstalled.
+ \row
+ \li SupportsModify
+ \li Set to \c false if the product does not support modifying an existing installation.
\endtable
@@ -543,11 +560,12 @@
\row
\li DisplayName
\li Human-readable name of the component. Required.
+ Specify translations for the name of the component as values of additional
+ DisplayName tags, with the xml:lang attribute set to the correct locale.
\row
\li Description
\li Human-readable description of the component. Required.
- Specify translations for the description as values of additional
- Description tags, with the xml:lang attribute set to the correct locale.
+ Translations may be specified similarly to DisplayName tag.
If a localization that matches the locale is not found and an untranslated
version exists, that one will be used. Otherwise no Description will be
shown for that locale.
@@ -603,6 +621,8 @@
\li List of license agreements to be accepted by the installing
user. To add several licenses, add several \c <License> child
elements that each specify the license \c name and \c file.
+ ASCII and UTF8 file formats are supported for license files.
+
If there are translations listed for this component, the installer
will also look for translated licenses. These need to have the
same name as the original license file but with an added
@@ -667,6 +687,11 @@
\li RequiresAdminRights
\li Set to \c true if the package needs to be installed with elevated permissions.
Optional.
+ \row
+ \li Checkable
+ \li Set to \c false if you want to hide the checkbox for an item. This is useful
+ when only a few subcomponents should be selected instead of all. Optional.
+
\endtable
\section2 Component Dependencies
@@ -830,6 +855,11 @@
\row
\li -v or --verbose
\li Display debug output.
+
+ \row
+ \li -s or --sign identity
+ \li Only available on OS X. Allows specifying a code signing identity to be
+ used for signing the generated app bundle.
\endtable
These parameters are followed by the name of the target binary and a list
@@ -839,6 +869,11 @@
their dependencies and all packages that share the same prefix, unless you
specify the \c --nodeps parameter.
+ In the optional resource files specified via the \c --resources parameter, a
+ special \c fonts/ path can be used to ship custom fonts. These fonts will
+ be loaded automatically and thus become available in a stylesheet which can
+ be specified via the \c StyleSheet variable.
+
On Windows, the name of the target binary is automatically extended with
.exe, if you do not specify the extension. On Mac, the target is
created as an application bundle with the extension .app, which is automatically