cmake-gui(1)

Краткое описание

cmake-gui [<options>]
cmake-gui [<options>] -B <path-to-build> [-S <path-to-source>]
cmake-gui [<options>] <path-to-source | path-to-existing-build>
cmake-gui [<options>] --browse-manual [<filename>]

Описание

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

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

Параметры

-S <path-to-source>

Путь к корневому каталогу проекта CMake для сборки.

-B <path-to-build>

Путь к каталогу, который CMake будет использовать в качестве корня каталога сборки.

Если каталог ещё не существует, CMake создаст его.

--preset=<preset-name>

Имя пресета, который нужно использовать из файлов пресетов проекта presets, если они есть.

--browse-manual [<filename>]

Открыть справочник CMake в браузере и немедленно выйти. Если указан <filename>, открыть этот файл внутри справочника вместо index.html.

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