diff options
| author | Israel Blancas <iblancasa@gmail.com> | 2018-05-01 18:33:57 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-05-02 17:10:17 (GMT) |
| commit | 7a50425caa4860355bafa8d9600026155f2d27d1 (patch) | |
| tree | 929c90fc4162b1c3a454febf8299bd1ee3b30c63 /Help | |
| parent | 4ac48237a0337a6d36556e0424e44baef38cad9a (diff) | |
| download | CMake-7a50425caa4860355bafa8d9600026155f2d27d1.zip CMake-7a50425caa4860355bafa8d9600026155f2d27d1.tar.gz CMake-7a50425caa4860355bafa8d9600026155f2d27d1.tar.bz2 | |
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.
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:: |