reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2025-02-24 22:12:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Help: Fix and clarify server mode --pipe= option docs

Browse Source 
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.
This commit is contained in:
Israel Blancas 2018-05-01 20:33:57 +02:00 committed by Brad King
parent 4ac48237a0
commit 7a50425caa
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Help/manual/cmake-server.7.rst
View File

@ -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::