cpack(1)

Синопсис

cpack [<options>]

Описание

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

Для каждого формата установщика или пакета cpack имеет определённый бэкенд, называемый «генератором». Генератор отвечает за создание необходимых входных данных и вызов соответствующих инструментов для создания пакетов. Эти генераторы установщиков или пакетов не следует путать с генераторами файлов make для команды 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 перед отправкой вопросов в список.