CPackWIX

CPack WiX генератор специфичные опции

Переменные, специфичные для генератора CPack WiX

Следующие переменные специфичны для установщиков, созданных на Windows с использованием WiX.

CPACK_WIX_UPGRADE_GUID

GUID обновления (Product/@UpgradeCode)

Будет автоматически сгенерирован, если не указан явно.

Он должен быть явно задан в виде постоянно генерируемого глобально уникального идентификатора (GUID), чтобы ваши установщики могли заменять существующие установки, использующие тот же GUID.

Вы можете, например, явно задать эту переменную в файле CMakeLists.txt со значением, сгенерированным по умолчанию. Вы не должны использовать GUID, которые вы не сгенерировали сами или которые могут принадлежать другим проектам.

GUID должен иметь следующий фиксированный синтаксис:

XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

(каждая X представляет собой заглавную шестнадцатеричную цифру)

CPACK_WIX_PRODUCT_GUID

GUID продукта (Product/@Id)

Будет автоматически сгенерирован, если не указан явно.

Если задан явно, это установит идентификатор продукта вашего установщика.

Установка прервётся, если будет обнаружена существующая установка, использующая тот же GUID.

GUID должен использовать синтаксис, описанный для CPACK_WIX_UPGRADE_GUID.

CPACK_WIX_LICENSE_RTF

Файл лицензии в формате RTF

Если у CPACK_RESOURCE_FILE_LICENSE расширение .rtf, он используется как есть.

Если у CPACK_RESOURCE_FILE_LICENSE расширение .txt, он неявно преобразуется в RTF генератором WiX. Ожидаемая кодировка файла .txt — UTF-8.

С помощью CPACK_WIX_LICENSE_RTF вы можете переопределить файл лицензии, используемый генератором WiX, в случае, если CPACK_RESOURCE_FILE_LICENSE имеет неподдерживаемый формат или преобразование .txt -> .rtf не работает как ожидается.

CPACK_WIX_PRODUCT_ICON

Иконка, отображаемая рядом с именем программы в списке «Установка и удаление программ».

Если задано, эта иконка используется вместо стандартной.

CPACK_WIX_UI_REF

Эта переменная позволяет переопределить идентификатор элемента <UIRef> в шаблоне WiX.

По умолчанию это WixUI_InstallDir в случае, если не определены компоненты CPack, и WixUI_FeatureTree в противном случае.

CPACK_WIX_UI_BANNER

Растровый образ, отображаемый в верхней части всех страниц установщика, кроме диалогов приветствия и завершения.

Если задано, этот образ заменит стандартный баннер.

Этот образ должен иметь размер 493 на 58 пикселей.

CPACK_WIX_UI_DIALOG

Растровый образ в качестве фона для диалогов приветствия и завершения.

Если эта переменная задана, установщик заменит стандартный фон диалога.

Этот образ должен иметь размер 493 на 312 пикселей.

CPACK_WIX_PROGRAM_MENU_FOLDER

Имя папки в меню Пуск для запуска приложения.

Если эта переменная не задана, она инициализируется значением CPACK_PACKAGE_NAME.

CPACK_WIX_CULTURES

Язык(и) установщика

Языки компилируются в библиотеку расширений WiXUI. Для их использования просто укажите имя культуры. Если вы укажете более одного идентификатора культуры в списке, разделённом запятыми или точками с запятой, будет использоваться первый найденный. Список поддерживаемых языков можно найти по адресу: http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm

CPACK_WIX_TEMPLATE

Файл шаблона для генерации WiX

Если эта переменная задана, указанный шаблон будет использован для генерации файла WiX wxs. Это следует использовать, если требуется дополнительная настройка вывода.

Если эта переменная не задана, будет использован шаблон MSI по умолчанию, включённый в CMake.

CPACK_WIX_PATCH_FILE

Необязательный список XML-файлов с фрагментами, которые будут вставлены в сгенерированные исходные файлы WiX

Эта необязательная переменная может использоваться для указания XML-файла, который генератор WiX будет использовать для вставки фрагментов в сгенерированные исходные файлы.

Файлы патчей, понятные генератору CPack WiX, примерно следуют этой схеме RELAX NG compact:

start = CPackWiXPatch

CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }

CPackWiXFragment = element CPackWiXFragment
{
    attribute Id { string },
    fragmentContent*
}

fragmentContent = element * - CPackWiXFragment
{
    (attribute * { text } | text | fragmentContent)*
}

В настоящее время фрагменты могут быть вставлены в большинство элементов Component, File, Directory и Feature.

Следующие дополнительные специальные идентификаторы могут быть использованы:

• #PRODUCT для элемента <Product>.
• #PRODUCTFEATURE для корневого элемента <Feature>.

Следующий пример иллюстрирует, как это работает.

Предположим, что генератор WiX создаёт следующий XML-элемент:

<Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>

Следующий XML-файл патчей может быть использован для вставки элемента Environment:

<CPackWiXPatch>
  <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe">
    <Environment Id="MyEnvironment" Action="set"
      Name="MyVariableName" Value="MyVariableValue"/>
  </CPackWiXFragment>
</CPackWiXPatch>

CPACK_WIX_EXTRA_SOURCES

Дополнительные исходные файлы WiX

Эта переменная предоставляет необязательный список дополнительных исходных файлов WiX (.wxs), которые должны быть скомпилированы и связаны. Требуется полный путь к исходным файлам.

CPACK_WIX_EXTRA_OBJECTS

Дополнительные объектные файлы или библиотеки WiX

Эта переменная предоставляет необязательный список дополнительных объектных файлов WiX (.wixobj) и/или библиотек WiX (.wixlib). Требуется полный путь к объектам и библиотекам.

CPACK_WIX_EXTENSIONS

Эта переменная предоставляет список дополнительных расширений для инструментов WiX light и candle.

CPACK_WIX_<TOOL>_EXTENSIONS

Это версия CPACK_WIX_EXTENSIONS, специфичная для инструмента. <TOOL> может быть либо LIGHT, либо CANDLE.

CPACK_WIX_<TOOL>_EXTRA_FLAGS

Эта переменная позволяет передать дополнительные флаги инструменту WiX <TOOL>.

Используйте с осторожностью. Будущие версии CPack могут сгенерировать флаги, которые могут конфликтовать с вашими собственными.

<TOOL> может быть либо LIGHT, либо CANDLE.

CPACK_WIX_CMAKE_PACKAGE_REGISTRY

Если эта переменная задана, сгенерированный установщик создаст запись в ключе реестра Windows HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package>. Значение для <package> предоставляется этой переменной.

Предполагая, что вы также установили файл конфигурации CMake, это позволит другим проектам CMake найти ваш пакет с помощью команды find_package().

CPACK_WIX_PROPERTY_<PROPERTY>

Эта переменная может использоваться для предоставления значения для свойства установщика Windows <PROPERTY>

Следующий список содержит некоторые примеры свойств, которые могут быть использованы для настройки информации в разделе «Программы и компоненты» (также известном как «Установка и удаление программ»)

• ARPCOMMENTS - Комментарии
• ARPHELPLINK - URL справки и поддержки
• ARPURLINFOABOUT - URL общей информации
• ARPURLUPDATEINFO - URL информации об обновлениях
• ARPHELPTELEPHONE - Телефонный номер справки и поддержки
• ARPSIZE - Размер (в килобайтах) приложения

CPACK_WIX_ROOT_FEATURE_TITLE

Устанавливает имя корневой функции установки в установщике WIX. То же, что и CPACK_COMPONENT_<compName>_DISPLAY_NAME для компонентов.

CPACK_WIX_ROOT_FEATURE_DESCRIPTION

Устанавливает описание корневой функции установки в установщике WIX. То же, что и CPACK_COMPONENT_<compName>_DESCRIPTION для компонентов.

CPACK_WIX_SKIP_PROGRAM_FOLDER

Если эта переменная установлена в значение true, стандартное расположение установки сгенерированного пакета будет CPACK_PACKAGE_INSTALL_DIRECTORY непосредственно. Расположение установки не будет относительно папок ProgramFiles или ProgramFiles64.

Примечание

Установщики, созданные с этой функцией, не учитывают различия между системой, на которой создаётся установщик, и системой, на которой установщик может быть использован.

Поэтому возможно, что установщик, например, попытается установить в недоступный или нежелаемый диск или путь, не соответствующий локализации или соглашениям системы, на которой выполняется установка.

CPACK_WIX_ROOT_FOLDER_ID

Эта переменная позволяет указать пользовательский идентификатор корневой папки. Генератор-специфичный токен <64> может использоваться для идентификаторов папок, которые существуют в 32-битных и 64-битных вариантах. В 32-битных сборках токен будет расширяться пустым значением, а в 64-битных сборках он будет расширяться до 64.

Если не задана, сгенерированные установщики по умолчанию установят в ProgramFiles<64>Folder.

CPACK_WIX_ROOT

Эта переменная может быть необязательно установлена в корневую директорию пользовательской установки WiX Toolset.

Если не указано, CPack попытается найти установку WiX Toolset через переменную среды WIX.