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.