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.