summaryrefslogtreecommitdiffstats
path: root/Help/command/cmake_host_system_information.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/cmake_host_system_information.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/cmake_host_system_information.rst')
-rw-r--r--Help/command/cmake_host_system_information.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Help/command/cmake_host_system_information.rst b/Help/command/cmake_host_system_information.rst
new file mode 100644
index 0000000..ba545d5
--- /dev/null
+++ b/Help/command/cmake_host_system_information.rst
@@ -0,0 +1,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.