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.