diff options
author | Brad King <brad.king@kitware.com> | 2016-09-22 12:09:52 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2016-09-22 12:09:52 (GMT) |
commit | 3e14e594b41fe66d0366eadd5691c9a53e7e13c9 (patch) | |
tree | 7af0d35e000e40b1e0e9679d0f5181da86ce8ead /Help | |
parent | 555ef1e235e62236870b27adb1b6c384313bd792 (diff) | |
parent | 1d601c6cb978a3b6b6143fdf64e284fb3a098d1e (diff) | |
download | CMake-3e14e594b41fe66d0366eadd5691c9a53e7e13c9.zip CMake-3e14e594b41fe66d0366eadd5691c9a53e7e13c9.tar.gz CMake-3e14e594b41fe66d0366eadd5691c9a53e7e13c9.tar.bz2 |
Merge topic 'cmake-server-pipes'
1d601c6c server-mode: Introduce cmServerConnection
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-server.7.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst index 75aa0ee..00ffcd1 100644 --- a/Help/manual/cmake-server.7.rst +++ b/Help/manual/cmake-server.7.rst @@ -49,12 +49,16 @@ Operation Start :manual:`cmake(1)` in the server command mode, supplying the path to the build directory to process:: - cmake -E server + cmake -E server (--debug|--pipe <NAMED_PIPE>) -The server will start up and reply with an hello message on stdout:: +The server will communicate using stdin/stdout (with the ``--debug`` parameter) +or using a named pipe (with the ``--pipe <NAMED_PIPE>`` parameter). + +When connecting to the server (via named pipe or by starting it in ``--debug`` +mode), the server will reply with a hello message:: [== CMake Server ==[ - {"supportedProtocolVersions":[{"major":0,"minor":1}],"type":"hello"} + {"supportedProtocolVersions":[{"major":1,"minor":0}],"type":"hello"} ]== CMake Server ==] Messages sent to and from the process are wrapped in magic strings:: @@ -65,7 +69,8 @@ Messages sent to and from the process are wrapped in magic strings:: } ]== CMake Server ==] -The server is now ready to accept further requests via stdin. +The server is now ready to accept further requests via the named pipe +or stdin. Debugging |