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