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.