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