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

Важно отметить, что порядок аргументов -C и -D важен. Они будут выполнены в порядке их перечисления, при этом последний аргумент имеет приоритет над предыдущими. Например, если вы укажете -DCMAKE_BUILD_TYPE=Debug, за которым следует аргумент -C с файлом, который вызывает:

set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE)

то аргумент -C будет иметь приоритет, и CMAKE_BUILD_TYPE будет установлено в значение Release. Однако, если аргумент -D идёт после аргумента -C, он будет установлен в значение Debug.

Если вызов set(... CACHE ...) в файле -C не использует FORCE, и аргумент -D устанавливает ту же переменную, аргумент -D будет иметь приоритет независимо от порядка, из-за природы вызовов FORCE set(... CACHE ...).

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

-Wdeprecated

Включение предупреждений об устаревших функциях.

Включает предупреждения об использовании устаревших функций, предназначенных для автора файлов CMakeLists.txt.

-Wno-deprecated

Отключение предупреждений об устаревших функциях.

Отключает предупреждения об использовании устаревших функций, предназначенные для автора файлов CMakeLists.txt.

-Werror=<what>

Обработка предупреждений CMake как ошибок. <what> должно быть одним из следующих:

dev

Превращение предупреждений разработчиков в ошибки.

Превращение предупреждений, предназначенных для автора файлов CMakeLists.txt в ошибки. По умолчанию это также включает предупреждения об устаревших функциях как ошибки.

deprecated

Превращение предупреждений об устаревших макросах и функциях в ошибки.

Превращение предупреждений об использовании устаревших макросов и функций, предназначенных для автора файлов CMakeLists.txt в ошибки.

-Wno-error=<what>

Не обрабатывать предупреждения CMake как ошибки. <what> должно быть одним из следующих:

dev

Превращение предупреждений, предназначенных для автора файлов CMakeLists.txt в не ошибки. По умолчанию это также отключает предупреждения об устаревших функциях как ошибки.

deprecated

Превращение предупреждений об устаревших макросах и функциях, предназначенных для автора файлов CMakeLists.txt в не ошибки.

-version [<file>], --version [<file>], /V [<file>]

Отображение баннера с именем/версией программы и выход. Вывод печатается в указанный <file> файл, если он задан.

-h, -H, --help, -help, -usage, /?

Вывод информации об использовании и выход.

Инструкция по использованию описывает базовый командный интерфейс и его параметры.

--help-full [<file>]

Вывод всех руководств по справке и выход.

Все руководства выводятся в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-manual <man> [<file>]

Вывод одного руководства по справке и выход.

Указанное руководство печатается в удобочитаемом текстовом формате. Вывод печатается в указанный <file> файл, если он задан.

--help-manual-list [<file>]

Список доступных руководств по помощи и выход.

Список содержит все руководства, для которых помощь может быть получена с помощью опции --help-manual за которой следует имя руководства. Вывод выводится в указанный <file> файл, если задан.

--help-command <cmd> [<file>]

Вывод справки по одной команде и выход.

Запись из руководства cmake-commands(7) для <cmd> выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-command-list [<file>]

Список команд с доступной помощью и выход.

Список содержит все команды, для которых помощь может быть получена с помощью опции --help-command за которой следует имя команды. Вывод выводится в указанный <file> файл, если задан.

--help-commands [<file>]

Вывод руководства cmake-commands и выход.

Руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-module <mod> [<file>]

Вывод справки по одному модулю и выход.

Запись из руководства cmake-modules(7) для <mod> выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-module-list [<file>]

Список модулей с доступной помощью и выход.

Список содержит все модули, для которых помощь может быть получена с помощью опции --help-module за которой следует имя модуля. Вывод выводится в указанный <file> файл, если задан.

--help-modules [<file>]

Вывод руководства cmake-modules и выход.

Руководство cmake-modules(7) выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-policy <cmp> [<file>]

Вывод справки по одной политике и выход.

Запись из руководства cmake-policies(7) для <cmp> выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-policy-list [<file>]

Список политик с доступной помощью и выход.

Список содержит все политики, для которых помощь может быть получена с помощью опции --help-policy за которой следует имя политики. Вывод выводится в указанный <file> файл, если задан.

--help-policies [<file>]

Вывод руководства cmake-policies и выход.

Руководство cmake-policies(7) выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-property <prop> [<file>]

Вывод справки по одному свойству и выход.

Записи из руководства cmake-properties(7) для <prop> выводятся в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-property-list [<file>]

Список свойств с доступной помощью и выход.

Список содержит все свойства, для которых помощь может быть получена с помощью опции --help-property за которой следует имя свойства. Вывод выводится в указанный <file> файл, если задан.

--help-properties [<file>]

Вывод руководства cmake-properties и выход.

Руководство cmake-properties(7) выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-variable <var> [<file>]

Вывод справки по одной переменной и выход.

Запись из руководства cmake-variables(7) для <var> выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

--help-variable-list [<file>]

Список переменных с доступной помощью и выход.

Список содержит все переменные, для которых помощь может быть получена с помощью опции --help-variable за которой следует имя переменной. Вывод выводится в указанный <file> файл, если задан.

--help-variables [<file>]

Вывод руководства cmake-variables и выход.

Руководство cmake-variables(7) выводится в удобочитаемом текстовом формате. Вывод выводится в указанный <file> файл, если задан.

См. также

Для получения помощи по использованию CMake доступны следующие ресурсы:

Главная страница

https://cmake.org

Основная точка входа для изучения CMake.

Онлайн-документация и ресурсы сообщества

https://cmake.org/documentation

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

Форум Discourse

https://discourse.cmake.org

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