cpack(1)

Синопсис

cpack [<options>]

Описание

Исполняемый файл cpack — это программа паковки CMake. Она генерирует установщики и пакеты исходного кода в различных форматах.

Для каждого формата установщика или пакета cpack имеет определенный бэкенд, называемый «генератором». Генератор отвечает за генерацию необходимых входных данных и вызов специфических инструментов создания пакетов. Эти генераторы установщиков или пакетов не следует путать с генераторами файлов make, используемыми командой cmake.

Все поддерживаемые генераторы указаны в руководстве cpack-generators. Команда cpack --help выводит список генераторов, поддерживаемых целевой платформой. Выбор используемого генератора можно осуществить через переменную CPACK_GENERATOR или через параметр командной строки -G.

Программа cpack управляется конфигурационным файлом, написанным на языке CMake language. По умолчанию используется файл CPackConfig.cmake в текущем каталоге, если не указано иное через параметр командной строки --config.

В стандартном рабочем процессе CMake файл CPackConfig.cmake генерируется исполняемым файлом cmake, при условии, что модуль CPack включён в файл проекта CMakeLists.txt.

Параметры

-G <generators>

<generators> — это список имен генераторов, разделённых точкой с запятой. cpack переберёт этот список и создаст пакет(ы) в формате указанного генератора в соответствии с деталями, предоставленными в конфигурационном файле CPackConfig.cmake. Если этот параметр не указан, значения по умолчанию для набора генераторов определяются переменной CPACK_GENERATOR.

-C <configs>

Указывает конфигурацию(и) проекта, которые необходимо упаковать (например, Debug, Release, и т. д.), где <configs> — это список, разделённый точкой с запятой. Когда проект CMake использует генератор с несколькими конфигурациями, такой как Xcode или Visual Studio, этот параметр необходим, чтобы указать cpack какие исполняемые файлы, созданные для различных конфигураций, следует включать в пакет. Пользователь несёт ответственность за то, чтобы конфигурации, указанные в списке, были уже построены перед вызовом cpack.

-D <var>=<value>

Устанавливает переменную CPack. Это переопределит любое значение, заданное для <var> в файле входных данных, считанном cpack.

--config <configFile>

Указывает конфигурационный файл, считываемый cpack, чтобы предоставить детали паковки. По умолчанию используется файл CPackConfig.cmake в текущем каталоге.

--verbose, -V

Запустить cpack с подробным выводом. Это может использоваться для отображения более подробной информации от инструментов генерации пакетов и подходит для разработчиков проектов.

--debug

Запустить cpack с отладочным выводом. Этот параметр предназначен в основном для разработчиков самого cpack, и обычно разработчикам проектов он не требуется.

--trace

Перевести подлежащие скрипты cmake в режим отслеживания.

--trace-expand

Перевести подлежащие скрипты cmake в режим расширенного отслеживания.

-P <packageName>

Переопределить/определить значение переменной CPACK_PACKAGE_NAME, используемой для паковки. Любое значение, заданное для этой переменной в файле CPackConfig.cmake, будет проигнорировано.

-R <packageVersion>

Переопределить/определить значение переменной CPACK_PACKAGE_VERSION, используемой для паковки. Оно переопределит значение, заданное в файле CPackConfig.cmake, или значение, автоматически вычисленное из CPACK_PACKAGE_VERSION_MAJOR, CPACK_PACKAGE_VERSION_MINOR и CPACK_PACKAGE_VERSION_PATCH.

-B <packageDirectory>

Переопределить/определить CPACK_PACKAGE_DIRECTORY, который управляет каталогом, в котором CPack будет выполнять свою работу по паковке. Результирующий пакет(ы) по умолчанию будут созданы в этом месте, и под этим каталогом также будет создан подкаталог _CPack_Packages, который будет использоваться как рабочая область при создании пакета.

--vendor <vendorName>

Переопределить/определить CPACK_PACKAGE_VENDOR.

--help,-help,-usage,-h,-H,/?

Вывести информацию об использовании и выйти.

Информация об использовании описывает базовый интерфейс командной строки и его параметры.

--version,-version,/V [<f>]

Показать баннер с именем/версией программы и выйти.

Если указан файл, версия записывается в него. Справка выводится в указанный файл <f>айл, если он задан.

--help-full [<f>]

Вывести все справочные руководства и выйти.

Все руководства выводятся в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-manual <man> [<f>]

Вывести одно справочное руководство и выйти.

Указанное руководство выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-manual-list [<f>]

Вывести список доступных справочных руководств и выйти.

Список содержит все руководства, для которых справка может быть получена с помощью опции --help-manual в сочетании с именем руководства. Справка выводится в указанный файл <f>айл, если он задан.

--help-command <cmd> [<f>]

Вывести справку по одной команде и выйти.

Элемент справочника cmake-commands(7) для <cmd> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-command-list [<f>]

Вывести список команд со справкой и выйти.

Список содержит все команды, для которых справка может быть получена с помощью опции --help-command в сочетании с именем команды. Справка выводится в указанный файл <f>айл, если он задан.

--help-commands [<f>]

Вывести справочное руководство cmake-commands и выйти.

Справочное руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-module <mod> [<f>]

Вывести справку по одному модулю и выйти.

Элемент справочника cmake-modules(7) для <mod> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-module-list [<f>]

Вывести список модулей со справкой и выйти.

Список содержит все модули, для которых справка может быть получена с помощью опции --help-module в сочетании с именем модуля. Справка выводится в указанный файл <f>айл, если он задан.

--help-modules [<f>]

Вывести справочное руководство cmake-modules и выйти.

Справочное руководство cmake-modules(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-policy <cmp> [<f>]

Вывести справку по одной политике и выйти.

Элемент справочника cmake-policies(7) для <cmp> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-policy-list [<f>]

Вывести список политик со справкой и выйти.

Список содержит все политики, для которых справка может быть получена с помощью опции --help-policy в сочетании с именем политики. Справка выводится в указанный файл <f>айл, если он задан.

--help-policies [<f>]

Вывести справочное руководство cmake-policies и выйти.

Справочное руководство cmake-policies(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-property <prop> [<f>]

Вывести справку по одному свойству и выйти.

Элементы справочника cmake-properties(7) для <prop> выводятся в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-property-list [<f>]

Вывести список свойств со справкой и выйти.

Список содержит все свойства, для которых справка может быть получена с помощью опции --help-property в сочетании с именем свойства. Справка выводится в указанный файл <f>айл, если он задан.

--help-properties [<f>]

Вывести справочное руководство cmake-properties и выйти.

Справочное руководство cmake-properties(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-variable <var> [<f>]

Вывести справку по одной переменной и выйти.

Элемент справочника cmake-variables(7) для <var> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

--help-variable-list [<f>]

Вывести список переменных со справкой и выйти.

Список содержит все переменные, для которых справка может быть получена с помощью опции --help-variable в сочетании с именем переменной. Справка выводится в указанный файл <f>айл, если он задан.

--help-variables [<f>]

Вывести справочное руководство cmake-variables и выйти.

Справочное руководство cmake-variables(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если он задан.

См. также

Для получения помощи по использованию CMake доступны следующие ресурсы:

Главная страница

https://cmake.org

Основная стартовая точка для изучения CMake.

Онлайн-документация и ресурсы сообщества

https://cmake.org/documentation

Ссылки на доступную документацию и ресурсы сообщества можно найти на этой веб-странице.

Форум Discourse

https://discourse.cmake.org

Форум Discourse предоставляет возможность обсуждения и задавать вопросы о CMake.