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 в текущем каталоге.

-V, --verbose

Запустить 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.

--preset <presetName>

Использовать пресет из cmake-presets(7).

--list-presets

Вывести список пресетов из cmake-presets(7).

-version [<file>], --version [<file>], /V [<file>]

Показать баннер с именем и версией программы и завершить работу. Вывод будет напечатан в указанный файл <file>, если он задан.

-h, -H, --help, -help, -usage, /?

Вывести информацию об использовании и завершить работу.

Описание использования описывает базовый интерфейс командной строки и его опции.

--help <keyword> [<file>]

Вывести справку по одному ключевому слову CMake.

<keyword> может быть свойством, переменной, командой, политикой, генератором или модулем.

Соответствующая запись в руководстве для <keyword> выводится в удобочитаемом текстовом формате. Вывод напечатан в указанный файл <file>, если он задан.

Изменено в версии 3.28: До CMake 3.28 эта опция поддерживала только имена команд.

--help-full [<file>]

Вывести все справочные руководства и завершить работу.

Все руководства выводятся в удобочитаемом текстовом формате. Вывод напечатан в указанный файл <file>, если он задан.

--help-manual <man> [<file>]

Вывести одно справочное руководство и завершить работу.

Указанное руководство выводится в удобочитаемом текстовом формате. Вывод напечатан в указанный файл <file>, если он задан.

--help-manual-list [<file>]

Вывести список доступных справочных руководств и завершить работу.

Список содержит все руководства, для которых справка может быть получена с помощью опции --help-manual, за которой следует имя руководства. Вывод напечатан в указанный файл <file>, если он задан.

--help-command <cmd> [<file>]

Вывести справку по одной команде и завершить работу.

Запись в справочном руководстве cmake-commands(7) для <cmd> выводится в удобочитаемом текстовом формате. Вывод напечатан в указанный файл <file>, если он задан.

--help-command-list [<file>]

Вывести список команд со справкой и завершить работу.

Список содержит все команды, для которых справка может быть получена с помощью опции --help-command за которой следует имя команды. Вывод напечатан в указанный файл <file>, если он задан.

--help-commands [<file>]

Вывести справочное руководство cmake-commands и завершить работу.

Справочное руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Вывод напечатан в указанный файл <file>, если он задан.

--help-module <mod> [<file>]

Вывести справку по одному модулю и завершить работу.

В справочном разделе cmake-modules(7) по <mod> будет выведено описание в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-module-list [<file>]

Отобразить список модулей со доступной справкой и завершить работу.

Список содержит все модули, для которых может быть получена справка, используя опцию --help-module и имя модуля. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-modules [<file>]

Вывести руководство по cmake-modules и завершить работу.

Руководство cmake-modules(7) будет выведено в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-policy <cmp> [<file>]

Вывести справку по одному политике и завершить работу.

В справочном разделе cmake-policies(7) по <cmp> будет выведено описание в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-policy-list [<file>]

Отобразить список политик со доступной справкой и завершить работу.

Список содержит все политики, для которых может быть получена справка, используя опцию --help-policy и имя политики. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-policies [<file>]

Вывести руководство по cmake-policies и завершить работу.

Руководство cmake-policies(7) будет выведено в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-property <prop> [<file>]

Вывести справку по одному свойству и завершить работу.

В справочных разделах cmake-properties(7) по <prop> будет выведено описание в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-property-list [<file>]

Отобразить список свойств со доступной справкой и завершить работу.

Список содержит все свойства, для которых может быть получена справка, используя опцию --help-property и имя свойства. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-properties [<file>]

Вывести руководство по cmake-properties и завершить работу.

Руководство cmake-properties(7) будет выведено в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-variable <var> [<file>]

Вывести справку по одной переменной и завершить работу.

В справочном разделе cmake-variables(7) по <var> будет выведено описание в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-variable-list [<file>]

Отобразить список переменных со доступной справкой и завершить работу.

Список содержит все переменные, для которых может быть получена справка, используя опцию --help-variable и имя переменной. Вывод будет напечатан в указанный <file> файл, если он задан.

--help-variables [<file>]

Вывести руководство по cmake-variables и завершить работу.

Руководство cmake-variables(7) будет выведено в удобочитаемом формате. Вывод будет напечатан в указанный <file> файл, если он задан.

См. также

Ниже представлены доступные ресурсы для получения помощи по CMake:

Главная страница

https://cmake.org

Основная стартовая точка для изучения CMake.

Онлайн-документация и ресурсы сообщества

https://cmake.org/documentation

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

Форум Discourse

https://discourse.cmake.org

Форум Discourse предоставляет площадку для обсуждения и вопросов по CMake.