diff options
| author | Brad King <brad.king@kitware.com> | 2018-05-03 11:53:45 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-05-03 11:54:21 (GMT) |
| commit | 2d7a0862e41e9240c74f8d1ecef400fbf3f96ba8 (patch) | |
| tree | 759ea12b9675b82d074d44c5968047ee89b9bf4a /Help | |
| parent | 95759529967b31b5f72b9775806dbb9d68e01612 (diff) | |
| parent | 7a50425caa4860355bafa8d9600026155f2d27d1 (diff) | |
| download | CMake-2d7a0862e41e9240c74f8d1ecef400fbf3f96ba8.zip CMake-2d7a0862e41e9240c74f8d1ecef400fbf3f96ba8.tar.gz CMake-2d7a0862e41e9240c74f8d1ecef400fbf3f96ba8.tar.bz2 | |
Merge topic 'doc-server-pipe'
7a50425caa Help: Fix and clarify server mode --pipe= option docs
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2026
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-server.7.rst | 6 |
1 files 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 <NAMED_PIPE>) + cmake -E server (--debug|--pipe=<NAMED_PIPE>) The server will communicate using stdin/stdout (with the ``--debug`` parameter) -or using a named pipe (with the ``--pipe <NAMED_PIPE>`` parameter). +or using a named pipe (with the ``--pipe=<NAMED_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:: |