ccmake(1)

Резюме

ccmake [<options>] -B <path-to-build> [-S <path-to-source>]
ccmake [<options>] <path-to-source | path-to-existing-build>

Описание

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

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.