ccmake(1)

Синопсис

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

Описание

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

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.

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

Если указана часть :<type>, она должна быть одним из типов, указанных в документации к команде set() для её CACHE подписи. Если часть :<type> опущена, запись будет создана без типа, если она не существует с уже имеющимся типом. Если команда в проекте устанавливает тип в PATH или FILEPATH, то <value> будет преобразована в абсолютный путь.

Эту опцию также можно задать как один аргумент: -D<var>:<type>=<value> или -D<var>=<value>.

-U <globbing_expr>

Удаление соответствующих записей из кэша CMake.

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

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

-G <generator-name>

Указание генератора системы сборки.

CMake может поддерживать несколько собственных систем сборки на определённых платформах. Генератор отвечает за генерацию конкретной системы сборки. Возможные имена генераторов указаны в руководстве cmake-generators(7).

-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, прежде чем задавать вопросы на этом списке рассылки.