summaryrefslogtreecommitdiff
path: root/Help/command/cmake_host_system_information.rst
blob: 9402d57e97d5b876010eaa5a11caa59470da4c99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
cmake_host_system_information
-----------------------------

Query host system specific information.

::

  cmake_host_system_information(RESULT <variable> QUERY <key> ...)

Queries system information of the host system on which cmake runs.
One or more ``<key>`` can be provided to select the information to be
queried.  The list of queried values is stored in ``<variable>``.

``<key>`` can be one of the following values:

::

  NUMBER_OF_LOGICAL_CORES   = Number of logical cores.
  NUMBER_OF_PHYSICAL_CORES  = Number of physical cores.
  HOSTNAME                  = Hostname.
  FQDN                      = Fully qualified domain name.
  TOTAL_VIRTUAL_MEMORY      = Total virtual memory in megabytes.
  AVAILABLE_VIRTUAL_MEMORY  = Available virtual memory in megabytes.
  TOTAL_PHYSICAL_MEMORY     = Total physical memory in megabytes.
  AVAILABLE_PHYSICAL_MEMORY = Available physical memory in megabytes.