diff options
Diffstat (limited to 'doc/installerfw-using.qdoc')
| -rw-r--r-- | doc/installerfw-using.qdoc | 95 |
1 files changed, 71 insertions, 24 deletions
diff --git a/doc/installerfw-using.qdoc b/doc/installerfw-using.qdoc index a2aac9046..3cc52fb1a 100644 --- a/doc/installerfw-using.qdoc +++ b/doc/installerfw-using.qdoc @@ -33,12 +33,12 @@ \title End User Workflows The end user experience is similar for offline and online installers. - Along with your application, the installers install a maintenance tool that + Along with your application, the installers install a \MT that consists of a package manager, an updater, and an uninstaller. End users can - use the maintenance tool to add, update, and remove components. The - maintenance tool connects to an external repository to fetch the components + use the \MT to add, update, and remove components. The + \MT connects to an external repository to fetch the components to add or update. You can specify the repository in the configuration file - or end users can specify it in the maintenance tool settings. + or end users can specify it in the \MT settings. You can support the following end user workflows: @@ -177,7 +177,7 @@ If end users did not select all the components available for installation during the initial installation, they can use the package manager to install the remaining components from a repository later. The package manager is - part of a maintenance tool that is installed together with the application + part of a \MT that is installed together with the application during the initial installation. This only works if a repository that contains the components is available either locally or externally. @@ -186,14 +186,14 @@ \image ifw-user-flow-adding.png "Add components workflow" - This section uses the \e {Maintenance Tool} installed by the Qt 5 installer + This section uses the \e {\MT} installed by the Qt 5 installer run on macOS as an example implementation of how end users can add components - after the initial installation. The Maintenance Tool contains the package + after the initial installation. The \MT contains the package manager, updater, and uninstaller. \section1 Starting Package Manager - When end users start the Maintenance Tool, the introduction page opens: + When end users start the \MT, the introduction page opens: \image ifw-add-components-introduction.png "Introduction page" @@ -242,12 +242,12 @@ \image ifw-user-flow-removing.png "Remove components workflow" - This section uses the Qt 5 Maintenance Tool run on macOS as an example + This section uses the Qt 5 \MT run on macOS as an example implementation of how end users can remove all or selected components. \section1 Removing All Components - When end users start the Maintenance Tool, the introduction page opens: + When end users start the \MT, the introduction page opens: \image ifw-add-components-introduction.png "Introduction page" @@ -294,12 +294,12 @@ \image ifw-user-flow-updating.png "Updating workflow" - This section uses the Qt 5 Maintenance Tool run on macOS as an example + This section uses the Qt 5 \MT run on macOS as an example implementation of how end users can update installed components. \section1 Starting Updater - When end users start the Maintenance Tool, the introduction page opens: + When end users start the \MT, the introduction page opens: \image ifw-updating-introduction.png "Introduction page" @@ -339,9 +339,9 @@ \title Specifying Settings - Settings pages enable end users to specify proxy settings or install add-on - components. End users select \gui Settings on the introduction page to - specify the settings. + Settings pages enable end users to specify proxy settings, install add-on + components, and modify local cache parameters. End users select \gui Settings + on the introduction page to specify the settings. \section1 Specifying Proxy Settings @@ -366,6 +366,14 @@ After the installation, only default and user-defined repositories will be available. + \section1 Specifying Local Cache Settings + + The installers use a local cache for the meta information fetched from remote + repositories. This improves loading times when the same metadata is accessed + multiple times. End users can configure the location of the metadata cache and + clear the contents of an existing cache. + + \image ifw-settings-cache.png "Local Cache tab on Settings page" */ /*! @@ -383,7 +391,7 @@ \section1 Installing Components - Both the installer and the maintenance tool support installation of new components from + Both the installer and the \MT support installation of new components from command line. The following will install the components given as an argument and their respective dependencies: @@ -400,10 +408,17 @@ installer.exe --root "C:\Users\MyUser\MyInstallation" install \endcode + The install command can be also used for installing component aliases. If component + aliases are specified, the aliased components are selected for installation: + + \code + maintenancetool.exe install alias1 alias2 + \endcode + \section1 Checking for Available Updates To print information about available component updates, run the \c check-updates - command with the maintenance tool: + command with the \MT: \code maintenancetool.exe check-updates @@ -436,7 +451,7 @@ \section1 Listing Installed Components To get a list and print additional information about currently installed components, run the - \c list command with the maintenance tool. The command also accepts an optional regular + \c list command with the \MT. The command also accepts an optional regular expression argument to filter the shown component list. \code @@ -448,17 +463,36 @@ The \c search command can be used to search components from available repositories, or from integrated binary content in case of an offline installer. It can be used with no arguments to list all available components or with a regular expression to get a list - of only components matching the pattern. The \c --filter-packages option can be - used to specify additional filters for the search operation. For a list of usable - information elements with the option, refer to \l{Summary of Package Information File Elements}. + of only components matching the pattern. + + The \c --filter-packages option can be used to specify additional filters for the search + operation. For a list of usable information elements with the option, refer to + \l{Summary of Package Information File Elements}. + + When the value of the \c{--type} option is set to \c package, the search command will + search for available components only: + + \code + installer.exe --type package --filter-packages "DisplayName=MyComponent, Version=1.0" search "expression" + \endcode + + When the \c{--type} option is omitted, the search command will first search for matching + component aliases, and if none are found, component names: + + \code + installer.exe search "expression" + \endcode + + When the value of the \c{--type} option is set to \c alias, the search command will + search for available component aliases only: \code - installer.exe --filter-packages "DisplayName=MyComponent, Version=1.0" search "expression" + installer.exe --type alias search "expression" \endcode \section1 Performing Full Uninstallation - To uninstall all components and remove the program directory, including maintenance tool, + To uninstall all components and remove the program directory, including \MT, run \c purge command: \code @@ -479,6 +513,19 @@ installer.exe --root "C:\TargetFolder" --offline-installer-name "MyInstaller" create-offline componentA componentB \endcode + \section1 Clearing the Local Cache + + Online installers and maintenance tools created with the Qt Installer Framework cache the + meta information downloaded from remote repositories to local disk. This improves loading + times for subsequent metadata downloads. + + The cache may grow in size over time. To clear the contents of the entire cache, + use the \c clear-cache command: + + \code + maintenancetool.exe clear-cache + \endcode + \section1 Unattended Usage By default, the generated installers may ask for additional information during installation, @@ -497,7 +544,7 @@ \c {--auto-answer OverwriteTargetDirectory=Yes}. Automatic answers are shown on the console output and installation log. - By default, the installer and maintenance tool will print a summary of components to be + By default, the installer and \MT will print a summary of components to be affected by the command and then ask for permission to continue performing the action, to prevent accidental changes. For unattended usage, this can be skipped by using the \c --confirm-command option. |