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-команд и завершить работу.

Руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-module <mod> [<file>]

Вывести справку по одному модулю и завершить работу.

Запись справки из руководства cmake-modules(7) для <mod> выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-module-list [<file>]

Вывести список модулей со доступной справкой и завершить работу.

Список содержит все модули, для которых справку можно получить, используя опцию --help-module и имя модуля. Вывод печатается в указанный <file> файл, если он задан.

--help-modules [<file>]

Вывести руководство cmake-модулей и завершить работу.

Руководство cmake-modules(7) выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-policy <cmp> [<file>]

Вывести справку по одной политике и завершить работу.

Запись справки из руководства cmake-policies(7) для <cmp> выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-policy-list [<file>]

Вывести список политик со доступной справкой и завершить работу.

Список содержит все политики, для которых справку можно получить, используя опцию --help-policy и имя политики. Вывод печатается в указанный <file> файл, если он задан.

--help-policies [<file>]

Вывести руководство cmake-политик и завершить работу.

Руководство cmake-policies(7) выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-property <prop> [<file>]

Вывести справку по одному свойству и завершить работу.

Записи справки из руководства cmake-properties(7) для <prop> выводятся в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-property-list [<file>]

Вывести список свойств со доступной справкой и завершить работу.

Список содержит все свойства, для которых справку можно получить, используя опцию --help-property и имя свойства. Вывод печатается в указанный <file> файл, если он задан.

--help-properties [<file>]

Вывести руководство cmake-свойств и завершить работу.

Руководство cmake-properties(7) выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-variable <var> [<file>]

Вывести справку по одной переменной и завершить работу.

Запись справки из руководства cmake-variables(7) для <var> выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-variable-list [<file>]

Вывести список переменных со доступной справкой и завершить работу.

Список содержит все переменные, для которых справку можно получить, используя опцию --help-variable и имя переменной. Вывод печатается в указанный <file> файл, если он задан.

--help-variables [<file>]

Вывести руководство cmake-переменных и завершить работу.

Руководство cmake-variables(7) выводится в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

См. также

Для получения помощи в использовании CMake доступны следующие ресурсы:

Главная страница

https://cmake.org

Основная стартовая точка для обучения работе с CMake.

Онлайн-документация и ресурсы сообщества

https://cmake.org/documentation

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

Форум Discourse

https://discourse.cmake.org

Форум Discourse предоставляет площадку для обсуждения и вопросов о CMake.