server-mode: Report CMakeCache entries

With this it would be possible to implement something like
cmake-gui using server-mode.

1 files changed, 36 insertions, 0 deletions

diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst
index 76ee3fb914..f66212522d 100644
--- a/Help/manual/cmake-server.7.rst
+++ b/Help/manual/cmake-server.7.rst
@@ -599,3 +599,39 @@ The list of files which "isCMake" set to true are part of the cmake installation
 
 The list of files witch "isTemporary" set to true are part of the build directory
 and will not survive the build directory getting cleaned out.
+
+
+Type "cache"
+^^^^^^^^^^^^
+
+The "cache" request can be used once a project is configured and will
+list the cached configuration values.
+
+Example::
+
+  [== CMake Server ==[
+  {"type":"cache"}
+  ]== CMake Server ==]
+
+CMake will respond with the following output::
+
+  [== CMake Server ==[
+  {
+    "cookie":"","inReplyTo":"cache","type":"reply",
+    "cache":
+    [
+      {
+        "key":"SOMEVALUE",
+        "properties":
+        {
+          "ADVANCED":"1",
+          "HELPSTRING":"This is not helpful"
+        }
+        "type":"STRING",
+        "value":"TEST"}
+    ]
+  }
+  ]== CMake Server ==]
+
+The output can be limited to a list of keys by passing an array of key names
+to the "keys" optional field of the "cache" request.