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 <Configuration>

Укажите конфигурацию проекта для упаковки (например, Debug, Release, и т.д.). Когда проект CMake использует многоконфигурационный генератор, такой как Xcode или Visual Studio, этот параметр необходим, чтобы указать 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

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

Список рассылки

https://cmake.org/mailing-lists

Для получения помощи и обсуждения использования cmake предоставлен список рассылки по адресу cmake@cmake.org. Список предназначен только для участников, но можно подписаться на CMake веб-странице. Прежде чем отправлять вопросы на список, пожалуйста, сначала прочитайте всю документацию по адресу https://cmake.org.