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.