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.

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