ccmake(1)

Синопсис

ccmake [<options>] -B <path-to-build> [-S <path-to-source>]
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>

Добавлен в версии 3.21.

Укажите файл инструментальной цепочки для кросс-компиляции, эквивалентно установке переменной CMAKE_TOOLCHAIN_FILE. Относительные пути интерпретируются как относительные к каталогу сборки, и если не найдены, относительные к каталогу исходных файлов.

--install-prefix <directory>

Добавлен в версии 3.21.

Укажите каталог установки, используемый переменной 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 <keyword> [<file>]

Вывести справку по одному ключевому слову CMake.

<keyword> может быть свойством, переменной, командой, политикой, генератором или модулем.

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

Изменено в версии 3.28: До версии CMake 3.28 этот параметр поддерживал только имена команд.

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