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.