Browse Source

Help: Document site_name command use of HOSTNAME variable

Brad King 5 years ago
parent
commit
94c6295db1
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Help/command/site_name.rst

+ 4 - 0
Help/command/site_name.rst

@@ -6,3 +6,7 @@ Set the given variable to the name of the computer.
 .. code-block:: cmake
 
   site_name(variable)
+
+On UNIX-like platforms, if the variable ``HOSTNAME`` is set, its value
+will be executed as a command expected to print out the host name,
+much like the ``hostname`` command-line tool.