ccmake(1)

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

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

Описание

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

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>

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

--install-prefix <directory>

Указание каталога установки, используемого переменной 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-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.