diff options
author | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2020-02-20 10:11:12 (GMT) |
---|---|---|
committer | Joachim Wuttke (h) <j.wuttke@fz-juelich.de> | 2020-02-20 19:25:34 (GMT) |
commit | 1af49def54575742dd78641f78eb7156e738e76a (patch) | |
tree | 87a2acfc111fbc053ac39dc9e86b6c80b5a979f3 /Help/cpack_gen/ifw.rst | |
parent | 907ffbf52eb08ea4899ab8aa86427264b20203f5 (diff) | |
download | CMake-1af49def54575742dd78641f78eb7156e738e76a.zip CMake-1af49def54575742dd78641f78eb7156e738e76a.tar.gz CMake-1af49def54575742dd78641f78eb7156e738e76a.tar.bz2 |
Help: CPackIFW generator: offline installer
Bundle subsections under "Other Settings".
Improve explanation of the Online installer.
Diffstat (limited to 'Help/cpack_gen/ifw.rst')
-rw-r--r-- | Help/cpack_gen/ifw.rst | 83 |
1 files changed, 45 insertions, 38 deletions
diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst index d7c71b4..776bb46 100644 --- a/Help/cpack_gen/ifw.rst +++ b/Help/cpack_gen/ifw.rst @@ -24,33 +24,6 @@ The :module:`CPackIFW` module looks for the location of the QtIFW command-line utilities, and defines several commands to control the behavior of this generator. -Internationalization -^^^^^^^^^^^^^^^^^^^^ - -Some variables and command arguments support internationalization via -CMake script. This is an optional feature. - -Installers created by QtIFW tools have built-in support for -internationalization and many phrases are localized to many languages, -but this does not apply to the description of the your components and groups -that will be distributed. - -Localization of the description of your components and groups is useful for -users of your installers. - -A localized variable or argument can contain a single default value, and a -set of pairs the name of the locale and the localized value. - -For example: - -.. code-block:: cmake - - set(LOCALIZABLE_VARIABLE "Default value" - en "English value" - en_US "American value" - en_GB "Great Britain value" - ) - Variables ^^^^^^^^^ @@ -300,24 +273,58 @@ the path may be specified in either a CMake or an environment variable: The :variable:`CPACK_IFW_ROOT` variable has a higher priority and overrides the value of the :variable:`QTIFWDIR` variable. +Other Settings +^^^^^^^^^^^^^^ Online installer -^^^^^^^^^^^^^^^^ +"""""""""""""""" -By default CPack IFW generator makes offline installer. This means that all -components will be packaged into a binary file. +By default, this generator generates an *offline installer*. This means that +that all packaged files are fully contained in the installer executable. -To make a component downloaded, you must set the ``DOWNLOADED`` option in -:command:`cpack_add_component`. +In contrast, an *online installer* will download some or all components from +a remote server. -Then you would use the command :command:`cpack_configure_downloads`. -If you set ``ALL`` option all components will be downloaded. +The ``DOWNLOADED`` option in the :command:`cpack_add_component` command +specifies that a component is to be downloaded. Alternatively, the ``ALL`` +option in the :command:`cpack_configure_downloads` command specifies that +`all` components are to be be downloaded. -You also can use command :command:`cpack_ifw_add_repository` and -variable :variable:`CPACK_IFW_DOWNLOAD_ALL` for more specific configuration. +The :command:`cpack_ifw_add_repository` command and the +:variable:`CPACK_IFW_DOWNLOAD_ALL` variable allow for more specific +configuration. -CPack IFW generator creates "repository" dir in current binary dir. You -would copy content of this dir to specified ``site`` (``url``). +When there are online components, CPack will write them to archive files. +The help page of the :module:`CPackComponent` module, especially the section +on the :command:`cpack_configure_downloads` function, explains how to make +these files accessible from a download URL. + +Internationalization +"""""""""""""""""""" + +Some variables and command arguments support internationalization via +CMake script. This is an optional feature. + +Installers created by QtIFW tools have built-in support for +internationalization and many phrases are localized to many languages, +but this does not apply to the description of the your components and groups +that will be distributed. + +Localization of the description of your components and groups is useful for +users of your installers. + +A localized variable or argument can contain a single default value, and a +set of pairs the name of the locale and the localized value. + +For example: + +.. code-block:: cmake + + set(LOCALIZABLE_VARIABLE "Default value" + en "English value" + en_US "American value" + en_GB "Great Britain value" + ) See Also ^^^^^^^^ |