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.

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

-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

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

Форум Discourse

https://discourse.cmake.org

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