diff options
Diffstat (limited to 'doc/installerfw.qdoc')
| -rw-r--r-- | doc/installerfw.qdoc | 96 |
1 files changed, 81 insertions, 15 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index fbcab3cd4..9cfb94d06 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -182,7 +182,15 @@ \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. + a '.icns' (Mac OS X), '.ico' (Windows) or '.png' (Unix) suffix. Deprecated, + use InstallerApplicationIcon and / or InstallerWindowIcon instead. + \row + \o InstallerApplicationIcon + \o Filename for a custom installer icon. The actual file is looked up by attaching + a '.icns' (Mac OS X), '.ico' (Windows). No functionality on Unix. + \row + \o InstallerWindowIcon + \o Filename for a custom window icon in PNG format for the Installer application. \row \o Logo \o Filename for a logo used as \a QWizard::LogoPixmap. @@ -190,13 +198,19 @@ \o Watermark \o Filename for a watermark used as \a QWizard::WatermarkPixmap. \row + \o Banner + \o Filename for a banner used as \a QWizard::BannerPixmap (only used by ModernStyle). + \row \o Background - \o Filename for an image used as \a QWizard::BackgroundPixmap. + \o Filename for an image used as \a QWizard::BackgroundPixmap (only used by MacStyle). \row \o RunProgram \o Command executed after the installer is done if the user accepts the action. \row + \o RunProgramArguments + \o Arguments passed to the program specified in RunProgram. + \row \o RunProgramDescription \o Text shown next to the check box for running the program after the installation. Defaults to \gui {Run <Name>}. @@ -247,9 +261,15 @@ \o TargetConfigurationFile \o Filename for the configuration file on the target. Default is components.xml. \row - \o Pages - \o Custom strings for labels in the installer pages. Deprecated, - see \l{Translating Pages} instead. + \o Translations + \o List of language codes to be used for translating the user interface. To add several language + variants, specify several Translation sections that each specify the name of a language + variant. Optional. For more information, see \l{Translating Pages}. + \row + \o UrlQueryString + \o This string needs to be in the form "key=value" and will be appended to archive download + requests. This can be used to transmit information to the webserver hosting the repository. + \endtable */ @@ -425,10 +445,11 @@ \row \o AutoDependOn \o Opposite of dependencies. Defines that this component should be - loaded if the specified component is loaded. + loaded if all of the specified components are loaded. \row \o Virtual \o Set to \c true to hide the component from the installer. + Note that setting this on a root component does not work. \row \o SortingPriority \o Priority of the component in the tree. The tree is sorted from @@ -469,6 +490,8 @@ \o Default \o Possible values are: \c true, \c false, and \c script. Set to \c true to preselect the component in the installer. + This takes effect only on components that have no visible + child components. The boolean values are evaluated directly, while \c script is resolved during runtime. Add the name of the script as a value of the \c Script setting in this file. For an example script, @@ -477,7 +500,10 @@ \o Essential \o Marks the package as essential to force a restart of the \c UpdateAgent or \c MaintenanceTool. This is relevant for - updates found with \c UpdateAgent. + updates found with \c UpdateAgent. If there are updates available + for an essential component, the package manager stays disabled + until that component is updated. Newly introduced essential components + are automatically installed when running the updater. \row \o ForcedInstallation \o Determines that the package must always be installed. End users @@ -488,7 +514,11 @@ \row \o DownloadableArchives - \o Lists the data files (separated by commas) for an online installer to download. Optional. + \o Lists the data files (separated by commas) for an online + installer to download. + If there is some data inside the component and the package.xml + and/or the script has no DownloadableArchives value, the + repogen tool registers the found data automatically. \endtable \section2 Component Dependencies @@ -772,12 +802,12 @@ repogen.exe -p <package_directory> -c <config_directory>\<config_file> repository <repository_directory> - For example, to create a repository that contains only com.nokia.sdk.qt and - com.nokia.sdk.qtcreator, enter the following + For example, to create a repository that contains only org.qt-project.sdk.qt and + org.qt-project.sdk.qtcreator, enter the following command: \code - repogen.exe -p packages -c installer-config\config.xml -i com.nokia.sdk.qt,com.nokia.sdk.qtcreator repository + repogen.exe -p packages -c installer-config\config.xml -i org.qt-project.sdk.qt,org.qt-project.sdk.qtcreator repository \endcode When the repository has been created, upload it to a web server. You must @@ -834,12 +864,12 @@ \endcode For example, enter the following command to create an installer binary - called SDKInstaller.exe that will not contain data for com.nokia.sdk.qt and - com.nokia.qtcreator, because those packages are downloaded from a remote + called SDKInstaller.exe that will not contain data for org.qt-project.sdk.qt and + org.qt-project.qtcreator, because those packages are downloaded from a remote repository: \code - binarycreator.exe -p installer-packages -c installer-config\config.xml -e com.nokia.sdk.qt,com.nokia.qtcreator SDKInstaller.exe + binarycreator.exe -p installer-packages -c installer-config\config.xml -e org.qt-project.sdk.qt,org.qt-project.qtcreator SDKInstaller.exe \endcode \section1 Reducing Installer Size @@ -886,7 +916,7 @@ Some options have default values, and therefore, you can omit them. For example, enter the following command to create an installer binary called SDKInstaller.exe that contains the packages identified by - com.nokia.sdk and their dependencies: + org.qt-project.sdk and their dependencies: \code binarycreator.exe --offline-only -c installer-config -p installer-packes SDKInstaller.exe @@ -976,6 +1006,42 @@ then Updates.xml. The package names include version numbers, and therefore, end users receive old packages until the new ones are fully uploaded. + \section1 Changing Repositories + + To have the current update repository point to other repositories, edit the + Updates.xml file in the current repository. You can add, replace, or remove + repositories. + + \code + <RepositoryUpdate> + <Repository action="..." OPTIONS /> + <Repository action="..." OPTIONS /> + </RepositoryUpdate> + \endcode + + \section2 Adding Repositories + To update a repository, add the following code to the RepositoryUpdate section: + + \code + <Repository action="add" url="http://www.example.com/repository" name="user" password="password" + displayname="Example Repository" /> + \endcode + + \section2 Removing Repositories + To remove a repository, add the following code to the RepositoryUpdate section: + + \code + <Repository action="remove" url="http://www.example.com/repository" /> + \endcode + + \section2 Replacing repositories + To replace one repository with another, add the following code to the RepositoryUpdate section: + + \code + <Repository action="replace" oldurl="http://www.example.com/repository" + newurl="http://www.example.com/newrepository" name="user" password="password" + displayname="New Example Repository" /> + \endcode */ /*! |