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

Ссылки на 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>.

-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. По умолчанию это также включит предупреждения об устаревании.

-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

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

Форум Discourse

https://discourse.cmake.org

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