cpack(1)

Синопсис

cpack [<options>]

Описание

Исполняемый файл cpack — это программа упаковки CMake. Проекты CMake используют команды install() для определения содержимого пакетов, которые могут быть сгенерированы этим инструментом в различных форматах. Модуль CPack значительно упрощает создание входного файла, используемого cpack, позволяя управлять большинством аспектов конфигурации упаковки непосредственно из собственных файлов CMakeLists.txt проекта CMake.

Параметры

-G <generators>

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

Если этот параметр не указан, переменная 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, прежде чем отправлять вопросы на список рассылки.