From 7a50425caa4860355bafa8d9600026155f2d27d1 Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Tue, 1 May 2018 20:33:57 +0200 Subject: Help: Fix and clarify server mode --pipe= option docs Document the `=` in the option name. Clarify the term "named pipe" as an abstraction of local domain sockets on Unix and named pipes on Windows. --- Help/manual/cmake-server.7.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Help/manual/cmake-server.7.rst b/Help/manual/cmake-server.7.rst index 0fed0b1..25d364c 100644 --- a/Help/manual/cmake-server.7.rst +++ b/Help/manual/cmake-server.7.rst @@ -49,10 +49,12 @@ Operation Start :manual:`cmake(1)` in the server command mode, supplying the path to the build directory to process:: - cmake -E server (--debug|--pipe ) + cmake -E server (--debug|--pipe=) The server will communicate using stdin/stdout (with the ``--debug`` parameter) -or using a named pipe (with the ``--pipe `` parameter). +or using a named pipe (with the ``--pipe=`` parameter). Note +that "named pipe" refers to a local domain socket on Unix and to a named pipe +on Windows. When connecting to the server (via named pipe or by starting it in ``--debug`` mode), the server will reply with a hello message:: -- cgit v0.12