cpack(1)

Синопсис

cpack [<options>]

Описание

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

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

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

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

В стандартном рабочем процессе 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.