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.