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:

start = CPackWiXPatch

CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }

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

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

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

Можно использовать следующие дополнительные специальные идентификаторы:

• #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 - Размер (в килобайтах) приложения