ccmake(1)

Синопсис

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 , а не файл формата кэша.

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

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

-Wno-dev

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

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

-Wdev

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

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

-Werror=dev

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

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

-Wno-error=dev

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

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

-Wdeprecated

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

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

-Wno-deprecated

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

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

-Werror=deprecated

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

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

-Wno-error=deprecated

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

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

--help,-help,-usage,-h,-H,/?

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

Информация об использовании описывает базовый интерфейс командной строки и его параметры.

--version,-version,/V [<f>]

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

Если файл указан, версия записывается в него. Справка выводится в указанный файл <f>, если он задан.

--help-full [<f>]

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

Все руководства выводятся в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>, если он задан.

--help-manual <man> [<f>]

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

Указанное руководство выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>, если он задан.

--help-manual-list [<f>]

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

Список содержит все руководства, справка по которым может быть получена с помощью параметра --help-manual, за которым следует имя руководства. Справка выводится в указанный файл <f>, если он задан.

--help-command <cmd> [<f>]

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

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

--help-command-list [<f>]

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

Список содержит все команды, справка по которым может быть получена с помощью параметра --help-command за которым следует имя команды. Справка выводится в указанный файл <f>, если он задан.

--help-commands [<f>]

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

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

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

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

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

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

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

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

--help-modules [<f>]

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

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

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

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

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

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

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

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

--help-policies [<f>]

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

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

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

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

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

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

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

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

--help-properties [<f>]

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

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

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

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

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

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

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

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

--help-variables [<f>]

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

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

См. также

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

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

https://cmake.org

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

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

https://cmake.org/documentation

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

Список рассылки

https://cmake.org/mailing-lists

Для получения помощи и обсуждения использования CMake предоставляется список рассылки по адресу cmake@cmake.org. Список является только для участников, но можно подписаться на сайте CMake. Пожалуйста, сначала ознакомьтесь со всей документацией по адресу https://cmake.org, прежде чем задавать вопросы на список рассылки.