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.