From 3e888dcc5eca000bb319262317312637ca8dff76 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Tue, 12 Feb 2013 16:29:11 +0100 Subject: Add missing config.xml elements to documentation Change-Id: Ib7325cc951983a7b9f73af7ae9e5da57386361a1 Reviewed-by: Leena Miettinen --- doc/installerfw.qdoc | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index de5e359ad..5950b0640 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -163,10 +163,10 @@ \o Description \row \o Name - \o Name of the product being installed. + \o Name of the product being installed. This is mandatory. \row \o Version - \o Version number of the product being installed. + \o Version number of the product being installed. This is mandatory. \row \o Title \o Name of the installer as displayed on the title bar. @@ -177,9 +177,16 @@ \o ProductUrl \o URL to a page that contains product information on your web site. + \row + \o Icon + \o Filename for a custom installer icon. The actual file is looked up by attaching + a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix. \row \o Logo \o Filename for a logo used as \a QWizard::LogoPixmap. + \row + \o LogoSmall + \o Filename for a logo used as \a QWizard::LogoSmallPixmap. \row \o Watermark \o Filename for a watermark used as \a QWizard::WatermarkPixmap. @@ -198,10 +205,6 @@ \o StartMenuDir \o Name of the default program group for the product in the Windows \gui Start menu. - \row - \o Icon - \o Filename of the installer icon. On Windows, .ico is appended, - on Mac, .icns is appended, and on Linux, .png is appended. \row \o TargetDir \o Default target directory for installation. @@ -219,6 +222,13 @@ \o Filename of the generated uninstaller. Defaults to \e uninstall. The platform-specific executable file extension is appended. + \row + \o UninstallerIniFile + \o Filename for the configuration of the generated uninstaller. Defaults to + \e {UninstallerName}.ini. + \row + \o RemoveTargetDir + \o Set to \c false if the target directory should not be deleted when uninstalling. \row \o AllowNonAsciiCharacters \o Set to \c true if the installation path can contain non-ASCII @@ -229,6 +239,17 @@ \row \o AllowSpaceInPath \o Set to \c true if the installation path can contain space characters. + \row + \o DependsOnLocalInstallerBinary + \o Set to \c true if you want to prohibit installation from an external resource, such + as a network drive. This might make sense for e.g. very big installers. + The option is only used on Windows. + \row + \o TargetConfigurationFile + \o Filename for the configuration file on the target. Default is components.xml. + \row + \o Pages + \o List of pages. \endtable */ -- cgit v1.2.3