cpack(1)

Резюме

cpack [<options>]

Описание

Исполняемый файл cpack — это программа для пакетирования CMake. Проекты CMake используют команды install() для определения содержимого пакетов, которые могут быть сгенерированы этим инструментом в различных форматах. Модуль CPack значительно упрощает создание входного файла, используемого cpack, позволяя управлять большинством аспектов конфигурации пакетирования непосредственно из собственных файлов CMakeLists.txt проекта CMake.

Параметры

-G <generators>

<generators> — это список, разделенный точкой с запятой имён генераторов. cpack будет проходить по этому списку и создавать пакеты в формате каждого генератора в соответствии с подробностями, указанными в файле конфигурации CPackConfig.cmake. Генератор отвечает за создание необходимых входных данных для определённой системы пакетирования и вызов инструментов этой системы для создания пакетов. Возможные имена генераторов указаны в разделе Generators руководства, а параметр --help перечисляет генераторы, поддерживаемые для целевой платформы. Если этот параметр не задан, переменная CPACK_GENERATOR определяет набор по умолчанию генераторов, которые будут использоваться.

-C <Configuration>

Указать конфигурацию проекта, подлежащую пакетированию (например, Debug, Release, и т. д.). Когда проект CMake использует генератор с многоконфигурационной поддержкой, такой как Xcode или Visual Studio, этот параметр необходим для того, чтобы указать 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

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

Список рассылки

https://cmake.org/mailing-lists

Для получения помощи и обсуждения использования cmake, предоставляется список рассылки по адресу cmake@cmake.org. Список является только для участников, но можно подписаться на сайте CMake. Сначала ознакомьтесь с полной документацией по адресу https://cmake.org перед отправкой вопросов в список рассылки.