ccmake(1)

Краткое описание

ccmake [<options>] -B <path-to-build> [-S <path-to-source>]
ccmake [<options>] <path-to-source | path-to-existing-build>

Описание

Исполняемый файл ccmake — это интерфейс CMake в формате curses. Настройки конфигурации проекта могут быть заданы интерактивно через этот графический интерфейс. Краткое руководство предоставляется в нижней части терминала во время работы программы.

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

Параметры

-S <path-to-source>

Путь к корневому каталогу проекта CMake для сборки.

-B <path-to-build>

Путь к каталогу, который CMake будет использовать в качестве корня каталога сборки.

Если каталог еще не существует, CMake его создаст.

-C <initial-cache>

Предварительная загрузка скрипта для заполнения кэша.

При первом запуске CMake в пустом дереве сборки он создает файл CMakeCache.txt и заполняет его настраиваемыми настройками для проекта. Этот параметр можно использовать для указания файла, из которого следует загрузить записи кэша перед первым проходом по файлам CMake проекта. Загруженные записи имеют приоритет над значениями по умолчанию проекта. Указанный файл должен быть скриптом CMake, содержащим команды set(), использующие параметр CACHE, а не файл в формате кэша.

Ссылок на CMAKE_SOURCE_DIR и CMAKE_BINARY_DIR в скрипте соответствуют верхнему уровню дерева исходного и бинарного кода.

-D <var>:<type>=<value>, -D <var>=<value>

Создание или обновление записи CMake CACHE.

При первом запуске CMake в пустом дереве сборки он создаёт файл CMakeCache.txt и заполняет его настраиваемыми настройками для проекта. Этот параметр можно использовать для задания настройки, которая имеет приоритет над значением по умолчанию проекта. Параметр можно повторять для любого количества записей CACHE.

Если указана часть :<type>, то она должна быть одним из типов, указанных в документации команды set() для её CACHE сигнатуры. Если часть :<type> опущена, запись будет создана без типа, если она не существует с уже имеющимся типом. Если команда в проекте устанавливает тип на PATH или FILEPATH, то <value> будет преобразован в абсолютный путь.

Этот параметр также может быть задан как одно аргумент: -D<var>:<type>=<value> или -D<var>=<value>.

Важно отметить, что порядок аргументов -C и -D значим. Они будут выполняться в том порядке, в котором они указаны, при этом последний аргумент имеет приоритет над предыдущими. Например, если вы задаёте -DCMAKE_BUILD_TYPE=Debug, за которым следует аргумент -C с файлом, вызывающим:

set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE)

то аргумент -C будет иметь приоритет, и CMAKE_BUILD_TYPE будет установлено в Release. Однако, если аргумент -D следует за аргументом -C, он будет установлен в Debug.

Если вызов set(... CACHE ...) в файле -C не использует FORCE, и аргумент -D задаёт ту же переменную, аргумент -D будет иметь приоритет независимо от порядка из-за характера вызовов, не являющихся FORCE set(... CACHE ...).

-U <globbing_expr>

Удаление соответствующих записей из CMake CACHE.

Этот параметр можно использовать для удаления одной или нескольких переменных из файла CMakeCache.txt, поддерживаются выражения подстановки с помощью * и ?. Параметр можно повторять для любого количества записей CACHE.

Используйте с осторожностью, вы можете сделать свой CMakeCache.txt неработоспособным.

-G <generator-name>

Указание генератора системы сборки.

CMake может поддерживать несколько родных систем сборки на определённых платформах. Генератор отвечает за генерацию конкретной системы сборки. Возможные имена генераторов указаны в руководстве cmake-generators(7).

Если не указано, CMake проверяет переменную среды CMAKE_GENERATOR, в противном случае использует встроенный выбор по умолчанию.

-T <toolset-spec>

Спецификация набора инструментов для генератора, если поддерживается.

Некоторые генераторы CMake поддерживают указание набора инструментов, чтобы указать родной системе сборки, как выбрать компилятор. Подробнее см. переменную CMAKE_GENERATOR_TOOLSET.

-A <platform-name>

Указание имени платформы, если это поддерживается генератором.

Некоторые генераторы CMake поддерживают указание имени платформы, чтобы родная система сборки могла выбрать компилятор или SDK. Подробнее см. переменную CMAKE_GENERATOR_PLATFORM.

--toolchain <path-to-file>

Добавлено в версии 3.21.

Указывает файл инструментальной цепочки для кросс-компиляции, эквивалентно установке переменной CMAKE_TOOLCHAIN_FILE.

--install-prefix <directory>

Добавлено в версии 3.21.

Указывает каталог установки, используемый переменной CMAKE_INSTALL_PREFIX. Должен быть абсолютным путём.

-Wno-dev

Отключение предупреждений разработчиков.

Отключаются предупреждения, предназначенные автору файлов CMakeLists.txt. По умолчанию это также выключает предупреждения об устаревших функциях.

-Wdev

Включение предупреждений разработчиков.

Включаются предупреждения, предназначенные автору файлов CMakeLists.txt. По умолчанию это также включает предупреждения об устаревших функциях.

-Wdeprecated

Включение предупреждений об устаревших функциях.

Включаются предупреждения об использовании устаревших функций, предназначенные автору файлов CMakeLists.txt.

-Wno-deprecated

Отключение предупреждений об устаревших функциях.

Отключаются предупреждения об использовании устаревших функций, предназначенные автору файлов CMakeLists.txt.

-Werror=<what>

Обработка предупреждений CMake как ошибок. <what> должен быть одним из следующих:

dev

Преобразование предупреждений разработчиков в ошибки.

Преобразование предупреждений, предназначенных автору файлов CMakeLists.txt, в ошибки. По умолчанию это также включает предупреждения об устаревших функциях как ошибки.

deprecated

Преобразование предупреждений об устаревших макросах и функциях в ошибки.

Преобразование предупреждений об использовании устаревших макросов и функций, предназначенных автору файлов CMakeLists.txt, в ошибки.

-Wno-error=<what>

Не обрабатывать предупреждения CMake как ошибки. <what> должен быть одним из следующих:

dev

Преобразование предупреждений, предназначенных автору файлов CMakeLists.txt, не в ошибки. По умолчанию это также выключает предупреждения об устаревших функциях как ошибки.

deprecated

Преобразование предупреждений об использовании устаревших макросов и функций, предназначенных автору файлов CMakeLists.txt, не в ошибки.

-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.