cmake(1)

Синопсис

Generate a Project Buildsystem
 cmake [<options>] <path-to-source>
 cmake [<options>] <path-to-existing-build>
 cmake [<options>] -S <path-to-source> -B <path-to-build>

Build a Project
 cmake --build <dir> [<options>] [-- <build-tool-options>]

Install a Project
 cmake --install <dir> [<options>]

Open a Project
 cmake --open <dir>

Run a Script
 cmake [{-D <var>=<value>}...] -P <cmake-script-file>

Run a Command-Line Tool
 cmake -E <command> [<options>]

Run the Find-Package Tool
 cmake --find-package [<options>]

View Help
 cmake --help[-<topic>]

Описание

Исполняемый файл cmake — это командная строка генератора кроссплатформенной системы сборки CMake. В синопсисе выше перечислены различные действия, которые может выполнять инструмент, как описано в разделах ниже.

Для сборки проекта ПО с помощью CMake, сгенерируйте систему сборки проекта. Дополнительно используйте cmake для сборки проекта, установки проекта или просто запустите соответствующий инструмент сборки (например, make) напрямую. cmake также может быть использован для просмотра справки.

Другие действия предназначены для использования разработчиками программного обеспечения, которые пишут скрипты на языке CMake language для поддержки своих сборок.

Для графических пользовательских интерфейсов, которые могут быть использованы вместо cmake, см. ccmake и cmake-gui. Для командных интерфейсов к средствам тестирования и упаковки CMake, см. ctest и cpack.

Для получения дополнительной информации о CMake в целом, см. также ссылки в конце этого руководства.

Введение в системы сборки CMake

Система сборки описывает, как собрать исполняемые файлы и библиотеки проекта из исходного кода, используя инструмент сборки для автоматизации процесса. Например, система сборки может быть Makefile для использования с командным make инструментом или файлом проекта для интегрированной среды разработки (IDE). Чтобы избежать необходимости поддержки нескольких таких систем сборки, проект может указать свою систему сборки абстрактно, используя файлы, написанные на языке CMake language. Из этих файлов CMake генерирует предпочтительную систему сборки локально для каждого пользователя через бэкенд, называемый генератором.

Для генерации системы сборки с помощью CMake необходимо выбрать следующее:

Дерево исходных файлов

Верхний каталог, содержащий исходные файлы, предоставленные проектом. Проект указывает свою систему сборки, используя файлы, как описано в руководстве cmake-language(7), начиная с файла верхнего уровня с именем CMakeLists.txt. Эти файлы указывают целевые объекты сборки и их зависимости, как описано в руководстве cmake-buildsystem(7).

Дерево сборки

Верхний каталог, в котором будут храниться файлы системы сборки и артефакты выходных данных сборки (например, исполняемые файлы и библиотеки). CMake запишет файл CMakeCache.txt для идентификации каталога как дерева сборки и сохранит постоянную информацию, такую как параметры конфигурации системы сборки.

Чтобы сохранить исходное дерево в первозданном виде, выполните внеисточниковый сборку, используя отдельное выделенное дерево сборки. Внеисточниковый сборка, в которой дерево сборки размещается в том же каталоге, что и дерево исходных файлов, также поддерживается, но не рекомендуется.

Генератор

Это выбирает тип системы сборки для генерации. См. руководство cmake-generators(7) для документации по всем генераторам. Запустите cmake --help , чтобы увидеть список доступных генераторов локально. Дополнительно используйте опцию -G ниже для указания генератора или просто примите по умолчанию выбранный CMake для текущей платформы.

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

Генерация системы сборки проекта

Запустите CMake с одной из следующих подписей команд для указания деревьев исходных и сборки и генерации системы сборки:

cmake [<options>] <path-to-source>

Использует текущий рабочий каталог в качестве дерева сборки и <path-to-source> в качестве дерева исходных файлов. Указанный путь может быть абсолютным или относительным к текущему рабочему каталогу. Дерево исходных файлов должно содержать файл CMakeLists.txt и не должно содержать файла CMakeCache.txt, поскольку последний идентифицирует существующее дерево сборки. Например:

$ mkdir build ; cd build
$ cmake ../src

cmake [<options>] <path-to-existing-build>

Использует <path-to-existing-build> в качестве дерева сборки и загружает путь к дереву исходных файлов из файла CMakeCache.txt, который должен быть сгенерирован предыдущим запуском CMake. Указанный путь может быть абсолютным или относительным к текущему рабочему каталогу. Например:

$ cd build
$ cmake .

cmake [<options>] -S <path-to-source> -B <path-to-build>

Использует <path-to-build> в качестве дерева сборки и <path-to-source> в качестве дерева исходных файлов. Указанные пути могут быть абсолютными или относительными к текущему рабочему каталогу. Дерево исходных файлов должно содержать файл CMakeLists.txt. Дерево сборки будет создано автоматически, если оно еще не существует. Например:

$ cmake -S src -B build

Во всех случаях <options> может содержать ноль или более опций из раздела Параметры ниже.

После генерации системы сборки можно использовать соответствующий собственный инструмент сборки для сборки проекта. Например, после использования генератора Unix Makefiles можно запустить make напрямую:

$ make
$ make install

В качестве альтернативы, можно использовать cmake для сборки проекта, автоматически выбрав и вызвав соответствующий собственный инструмент сборки.

Параметры

-S <path-to-source>

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

-B <path-to-build>

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

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

-C <initial-cache>

Предварительная загрузка скрипта для заполнения кэша.

Когда CMake впервые выполняется в пустом дереве сборки, он создаёт файл CMakeCache.txt и заполняет его настраиваемыми настройками проекта. Этот параметр может быть использован для указания файла, из которого следует загрузить записи кэша перед первым проходом по файлам CMake проекта. Загруженные записи имеют приоритет над значениями по умолчанию проекта. Указанный файл должен быть скриптом CMake, содержащим команды set(), использующие параметр CACHE, а не файл формата кэша.

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

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

-Wno-dev

Отключение предупреждений для разработчиков.

Отключение предупреждений, предназначенных для автора файлов CMakeLists.txt. По умолчанию это также выключает предупреждения о устаревших функциях.

-Wdev

Включение предупреждений для разработчиков.

Включение предупреждений, предназначенных для автора файлов CMakeLists.txt. По умолчанию это также включает предупреждения о устаревших функциях.

-Werror=dev

Превращение предупреждений для разработчиков в ошибки.

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

-Wno-error=dev

Превращение предупреждений для разработчиков не в ошибки.

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

-Wdeprecated

Включение предупреждений об устаревших функциях.

Включение предупреждений об использовании устаревших функций, предназначенных для автора файлов CMakeLists.txt.

-Wno-deprecated

Отключение предупреждений об устаревших функциях.

Отключение предупреждений об использовании устаревших функций, предназначенных для автора файлов CMakeLists.txt.

-Werror=deprecated

Превращение предупреждений о устаревших макросах и функциях в ошибки.

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

-Wno-error=deprecated

Превращение предупреждений о устаревших макросах и функциях не в ошибки.

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

-L[A][H]

Список не-расширенных кэшированных переменных.

Список CACHE переменных запустит CMake и выведет все переменные из кэша CMake CACHE, которые не помечены как INTERNAL или ADVANCED. Это позволит эффективно отобразить текущие настройки CMake, которые затем можно изменить с помощью параметра -D. Изменение некоторых переменных может привести к созданию большего количества переменных. Если указан A, то будут отображаться и расширенные переменные. Если указан H, то будет также отображаться справка по каждой переменной.

-N

Только режим просмотра.

Только загрузка кэша. На самом деле не выполняйте шаги конфигурации и генерации.

--graphviz=[file]

Генерация графа зависимостей graphviz, см. CMakeGraphVizOptions для получения более подробной информации.

Генерация файла graphviz, который будет содержать все зависимости библиотек и исполняемых файлов в проекте. Дополнительные сведения см. в документации к CMakeGraphVizOptions.

--system-information [file]

Вывести информацию об этой системе.

Вывод широкого спектра информации о текущей системе. Если запуск происходит из верхней части дерева бинарных файлов проекта CMake, он также выведет дополнительную информацию, такую как кэш, файлы журнала и т. д.

--loglevel=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>

Установка уровня ведения журнала.

Команда message() будет выводить сообщения только указанного уровня журнала или выше. Уровень журнала по умолчанию — STATUS.

--debug-trycompile

Не удалять дерево сборки try_compile(). Полезно только для одного try_compile() за раз.

Не удалять файлы и директории, созданные для вызовов try_compile(). Это полезно при отладке неудачных try_compiles. Однако это может повлиять на результаты try-compiles, так как старый мусор из предыдущего try-compile может привести к тому, что другой тест пройдёт или не пройдёт неправильно. Этот параметр лучше использовать для одного try-compile за раз и только при отладке.

--debug-output

Перевести cmake в режим отладки.

Выводить дополнительную информацию во время выполнения cmake, например, трассировки стека с вызовами message(SEND_ERROR).

--trace

Перевести cmake в режим трассировки.

Выводить трассировку всех вызовов и откуда.

--trace-expand

Перевести cmake в режим трассировки.

Как --trace, но с расширенными переменными.

--trace-source=<file>

Перевести cmake в режим трассировки, но выводить только строки указанного файла.

Разрешено несколько параметров.

--warn-uninitialized

Выводить предупреждения о неопределённых значениях.

Выводить предупреждение при использовании неопределённой переменной.

--warn-unused-vars

Выводить предупреждения об неиспользуемых переменных.

Находить переменные, которые объявлены или установлены, но не используются.

--no-warn-unused-cli

Не выводить предупреждения о параметрах командной строки.

Не искать переменные, объявленные в командной строке, но не используемые.

--check-system-vars

Поиск проблем с использованием переменных в системных файлах.

Обычно неиспользуемые и неинициализированные переменные ищутся только в CMAKE_SOURCE_DIR и CMAKE_BINARY_DIR. Этот флаг сообщает CMake о том, что следует также предупреждать об ошибках в других файлах.

Сборка проекта

CMake предоставляет командную строку для сборки уже сгенерированного дерева бинарных файлов проекта:

cmake --build <dir> [<options>] [-- <build-tool-options>]

Это абстрагирует командную строку средства сборки нативного инструмента с указанными параметрами:

--build <dir>

Директория двоичных файлов проекта для построения. Это обязательно и должно быть первым параметром.

--parallel [<jobs>], -j [<jobs>]

Максимальное количество одновременных процессов для использования при построении. Если <jobs> опущено, используется значение по умолчанию, задаваемое утилитой построения.

Переменная среды CMAKE_BUILD_PARALLEL_LEVEL, если она задана, определяет значение по умолчанию для параллельного уровня, когда этот параметр не указан.

Некоторые утилиты построения всегда строят параллельно. Использование значения <jobs> в виде 1 может быть использовано для ограничения до одного задания.

--target <tgt>..., -t <tgt>...

Построить <tgt> вместо целевого объекта по умолчанию. Можно указать несколько целевых объектов, разделяя их пробелами.

--config <cfg>

Для инструментов с несколькими конфигурациями выберите конфигурацию <cfg>.

--clean-first

Построить целевой объект clean сначала, а затем выполнить построение. (Для очистки, используйте --target clean.)

--use-stderr

Игнорируется. Поведение по умолчанию в CMake >= 3.0.

--verbose, -v

Включить подробный вывод — если поддерживается — включая команды построения, которые будут выполнены.

Этот параметр можно опустить, если переменная среды VERBOSE или кэшированная переменная CMAKE_VERBOSE_MAKEFILE заданы.

--

Передать оставшиеся параметры инструменту.

Запустите cmake --build без параметров для быстрого вывода справки.

Установить проект

CMake предоставляет командную строку для установки уже сгенерированного проекта двоичного дерева:

cmake --install <dir> [<options>]

Это можно использовать после построения проекта для запуска установки без использования сгенерированной системы построения или инструмента построения. Параметры:

--install <dir>

Директория двоичных файлов проекта для установки. Это обязательно и должно быть первым параметром.

--config <cfg>

Для генераторов с несколькими конфигурациями выберите конфигурацию <cfg>.

--component <comp>

Установка на основе компонентов. Установить только компонент <comp>.

--prefix <prefix>

Переопределить префикс установки, CMAKE_INSTALL_PREFIX.

--strip

Сжать перед установкой.

-v, --verbose

Включить подробный вывод.

Этот параметр можно опустить, если переменная среды VERBOSE задана.

Запустите cmake --install без параметров для быстрого вывода справки.

Открыть проект

cmake --open <dir>

Открыть сгенерированный проект в соответствующем приложении. Это поддерживается только некоторыми генераторами.

Режим обработки скрипта

cmake [{-D <var>=<value>}...] -P <cmake-script-file>

Обработать данный файл cmake как скрипт, написанный на языке CMake. Шаг конфигурации или генерации не выполняется, и кэш не изменяется. Если переменные определяются с помощью -D, это должно быть сделано до аргумента -P.

Запуск командной строки

CMake предоставляет встроенные инструменты командной строки через подпись

cmake -E <command> [<options>]

Запустите cmake -E или cmake -E help для получения краткого описания команд. Доступные команды:

capabilities

Отчёт о возможностях CMake в формате JSON. Вывод — это JSON-объект со следующими ключами:

version

JSON-объект с информацией о версии. Ключи:

string

Полная строка версии, отображаемая cmake --version.

major

Основной номер версии в виде целого числа.

minor

Дополнительный номер версии в виде целого числа.

patch

Номер исправления в виде целого числа.

suffix

Строка постфикса версии cmake.

isDirty

Логическое значение, установленное, если сборка cmake выполнена из грязного дерева.

generators

Список доступных генераторов. Каждый генератор — это JSON-объект со следующими ключами:

name

Строка, содержащая имя генератора.

toolsetSupport

true если генератор поддерживает наборы инструментов и false в противном случае.

platformSupport

true если генератор поддерживает платформы и false в противном случае.

extraGenerators

Список строк со всеми дополнительными генераторами, совместимыми с данным генератором.

fileApi

Необязательное поле, присутствующее при наличии cmake-file-api(7). Значение — это JSON-объект с одним членом:

requests

JSON-массив, содержащий ноль или более поддерживаемых запросов file-api. Каждый запрос — это JSON-объект с членами:

kind

Определяет один из поддерживаемых типов объектов.

version

JSON-массив, элементы которого представляют собой JSON-объекты, содержащие major и minor члены, определяющие целочисленные компоненты версии.

serverMode

true если cmake поддерживает серверный режим и false в противном случае.

chdir <dir> <cmd> [<arg>...]

Изменить текущую рабочую директорию и запустить команду.

compare_files [--ignore-eol] <file1> <file2>

Проверить, <file1> совпадает с <file2>. Если файлы совпадают, то возвращает 0, в противном случае 1. Опция --ignore-eol подразумевает сравнение по строкам и игнорирует различия между LF и CRLF.

copy <file>... <destination>

Копировать файлы в <destination> (файл или директория). Если указано несколько файлов, <destination> должна быть директорией и должна существовать. Поддержка шаблонов не реализована. copy следует за символьными ссылками. То есть копирует не ссылки, а файлы или директории, на которые они указывают.

copy_directory <dir>... <destination>

Копировать директории в директорию <destination>. Если директория <destination> не существует, она будет создана. copy_directory следует за символьными ссылками.

copy_if_different <file>... <destination>

Копировать файлы в <destination> (файл или директория), если они изменены. Если указано несколько файлов, <destination> должна быть директорией и должна существовать. copy_if_different следует за символьными ссылками.

echo [<string>...]

Отобразить аргументы как текст.

echo_append [<string>...]

Отобразить аргументы как текст без новой строки.

env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...

Запустить команду в изменённой среде.

environment

Отобразить текущие переменные среды.

make_directory <dir>...

Создать директории <dir>. При необходимости создать родительские директории тоже. Если директория уже существует, она будет проигнорирована.

md5sum <file>...

Создать контрольную сумму MD5 файлов в формате, совместимом с md5sum:

351abe79cd3800b38cdfb25d45015a15  file1.txt
052f86c15bbde68af55c7f7b340ab639  file2.txt

sha1sum <file>...

Создать контрольную сумму SHA1 файлов в формате, совместимом с sha1sum:

4bb7932a29e6f73c97bb9272f2bdc393122f86e0  file1.txt
1df4c8f318665f9a5f2ed38f55adadb7ef9f559c  file2.txt

sha224sum <file>...

Создать контрольную сумму SHA224 файлов в формате, совместимом с sha224sum:

b9b9346bc8437bbda630b0b7ddfc5ea9ca157546dbbf4c613192f930  file1.txt
6dfbe55f4d2edc5fe5c9197bca51ceaaf824e48eba0cc453088aee24  file2.txt

sha256sum <file>...

Создать контрольную сумму SHA256 файлов в формате, совместимом с sha256sum:

76713b23615d31680afeb0e9efe94d47d3d4229191198bb46d7485f9cb191acc  file1.txt
15b682ead6c12dedb1baf91231e1e89cfc7974b3787c1e2e01b986bffadae0ea  file2.txt

sha384sum <file>...

Создать контрольную сумму SHA384 файлов в формате, совместимом с sha384sum:

acc049fedc091a22f5f2ce39a43b9057fd93c910e9afd76a6411a28a8f2b8a12c73d7129e292f94fc0329c309df49434  file1.txt
668ddeb108710d271ee21c0f3acbd6a7517e2b78f9181c6a2ff3b8943af92b0195dcb7cce48aa3e17893173c0a39e23d  file2.txt

sha512sum <file>...

Создать контрольную сумму SHA512 файлов в формате, совместимом с sha512sum:

2a78d7a6c5328cfb1467c63beac8ff21794213901eaadafd48e7800289afbc08e5fb3e86aa31116c945ee3d7bf2a6194489ec6101051083d1108defc8e1dba89  file1.txt
7a0b54896fe5e70cca6dd643ad6f672614b189bf26f8153061c4d219474b05dad08c4e729af9f4b009f1a1a280cb625454bf587c690f4617c27e3aebdf3b7a2d  file2.txt

remove [-f] <file>...

Удалить файл(ы). Если какой-либо из перечисленных файлов уже не существует, команда возвращает ненулевой код выхода, но сообщение не регистрируется. Опция -f изменяет поведение, возвращая нулевой код выхода (т. е. успех) в таких ситуациях. remove не следует за символьными ссылками. То есть удаляет только ссылки, а не файлы, на которые они указывают.

remove_directory <dir>...

Удалить директории <dir> и их содержимое. Если директория не существует, она будет проигнорирована.

rename <oldname> <newname>

Переименовать файл или директорию (на одном томе). Если файл с именем <newname> уже существует, он будет заменён без предупреждения.

server

Запустить режим cmake-server(7).

sleep <number>...

Подождать заданное количество секунд.

tar [cxt][vf][zjJ] file.tar [<options>] [--] [<pathname>...]

Создать или извлечь архив tar или zip. Варианты:

c

Создать новый архив, содержащий указанные файлы. Если используется, аргумент <pathname>... является обязательным.

x

Извлечь из архива на диск. Аргумент <pathname>... может использоваться для извлечения только выбранных файлов или директорий. При извлечении выбранных файлов или директорий необходимо указать их точные имена, включая путь, как и в списке (-t).

t

Вывести содержимое архива. Аргумент <pathname>... может использоваться для вывода только выбранных файлов или директорий.

v

Вывести подробный вывод.

z

Сжать полученный архив с помощью gzip.

j

Сжать полученный архив с помощью bzip2.

J

Сжать полученный архив с помощью XZ.

--zstd

Сжать полученный архив с помощью Zstandard.

--files-from=<file>

Считывать имена файлов из указанного файла, по одному на строку. Пустые строки игнорируются. Строки не могут начинаться с - за исключением --add-file=<name>, чтобы добавить файлы, имена которых начинаются с -.

--format=<format>

Указать формат создаваемого архива. Поддерживаемые форматы: 7zip, gnutar, pax, paxr (ограниченный pax, по умолчанию) и zip.

--mtime=<date>

Указать время изменения, записанное в записях tarball.

--

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

time <command> [<args>...]

Запустить команду и отобразить время выполнения.

touch <file>...

Создаёт <file> если файл не существует. Если <file> существует, меняет время доступа и изменения <file>.

touch_nocreate <file>...

Отмечает файл, если он существует, но не создаёт его. Если файл не существует, он будет проигнорирован.

create_symlink <old> <new>

Создать символическую ссылку <new> с именем <old>.

Инструменты командной строки, специфичные для Windows

Следующие команды cmake -E доступны только в Windows:

delete_regv <key>

Удалить значение в реестре Windows.

env_vs8_wince <sdkname>

Выводит пакетный файл, который устанавливает среду для установленного в VS2005 Windows CE SDK.

env_vs9_wince <sdkname>

Выводит пакетный файл, который устанавливает среду для установленного в VS2008 Windows CE SDK.

write_regv <key> <value>

Записать значение в реестр Windows.

Запуск инструмента поиска пакетов

CMake предоставляет помощник pkg-config для проектов на основе Makefile:

cmake --find-package [<options>]

Он ищет пакет, используя find_package() и выводит полученные флаги в стандартный вывод. Это можно использовать вместо pkg-config для поиска установленных библиотек в проектах на основе простого Makefile или в проектах на основе autoconf (через share/aclocal/cmake.m4).

Просмотр справки

Для вывода выбранных страниц из документации CMake используйте

cmake --help[-<topic>]

с одним из следующих вариантов:

--help,-help,-usage,-h,-H,/?

Вывести информацию об использовании и выйти.

Информация об использовании описывает базовый интерфейс командной строки и его параметры.

--version,-version,/V [<f>]

Показать баннер с именем/версией программы и выйти.

Если указан файл, версия записывается в него. Справка выводится в указанный файл <f>айл, если задан.

--help-full [<f>]

Вывести все руководства по справке и выйти.

Все руководства выводятся в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-manual <man> [<f>]

Вывести одно руководство по справке и выйти.

Указанное руководство выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-manual-list [<f>]

Вывести список доступных руководств по справке и выйти.

Список содержит все руководства, по которым можно получить справку, используя опцию --help-manual в сочетании с именем руководства. Справка выводится в указанный файл <f>айл, если задан.

--help-command <cmd> [<f>]

Вывести справку по одной команде и выйти.

Запись справки по cmake-commands(7) для <cmd> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-command-list [<f>]

Вывести список команд со справкой и выйти.

Список содержит все команды, по которым можно получить справку, используя опцию --help-command в сочетании с именем команды. Справка выводится в указанный файл <f>айл, если задан.

--help-commands [<f>]

Вывести руководство cmake-commands и выйти.

Руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-module <mod> [<f>]

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

Запись справки по cmake-modules(7) для <mod> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-module-list [<f>]

Вывести список модулей со справкой и выйти.

Список содержит все модули, по которым можно получить справку, используя опцию --help-module в сочетании с именем модуля. Справка выводится в указанный файл <f>айл, если задан.

--help-modules [<f>]

Вывести руководство cmake-modules и выйти.

Руководство cmake-modules(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-policy <cmp> [<f>]

Вывести справку по одному принципу и выйти.

Запись справки по cmake-policies(7) для <cmp> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-policy-list [<f>]

Вывести список принципов со справкой и выйти.

Список содержит все принципы, по которым можно получить справку, используя опцию --help-policy в сочетании с именем принципа. Справка выводится в указанный файл <f>айл, если задан.

--help-policies [<f>]

Вывести руководство cmake-policies и выйти.

Руководство cmake-policies(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-property <prop> [<f>]

Вывести справку по одному свойству и выйти.

Записи справки по cmake-properties(7) для <prop> выводятся в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-property-list [<f>]

Вывести список свойств со справкой и выйти.

Список содержит все свойства, по которым можно получить справку, используя опцию --help-property в сочетании с именем свойства. Справка выводится в указанный файл <f>айл, если задан.

--help-properties [<f>]

Вывести руководство cmake-properties и выйти.

Руководство cmake-properties(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-variable <var> [<f>]

Вывести справку по одной переменной и выйти.

Запись справки по cmake-variables(7) для <var> выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

--help-variable-list [<f>]

Вывести список переменных со справкой и выйти.

Список содержит все переменные, по которым можно получить справку, используя опцию --help-variable в сочетании с именем переменной. Справка выводится в указанный файл <f>айл, если задан.

--help-variables [<f>]

Вывести руководство cmake-variables и выйти.

Руководство cmake-variables(7) выводится в удобочитаемом текстовом формате. Справка выводится в указанный файл <f>айл, если задан.

См. также

Для получения помощи по использованию CMake доступны следующие ресурсы:

Главная страница

https://cmake.org

Основная отправная точка для ознакомления с CMake.

Онлайн-документация и ресурсы сообщества

https://cmake.org/documentation

Ссылки на доступную документацию и ресурсы сообщества можно найти на этой веб-странице.

Список рассылки

https://cmake.org/mailing-lists

Для получения помощи и обсуждения использования CMake предоставляется список рассылки по адресу cmake@cmake.org. Список является списком рассылки для участников, но можно подписаться на веб-странице CMake. Сначала, пожалуйста, прочтите всю документацию по адресу https://cmake.org перед отправкой вопросов на список.