README.md
1# remote-process
2
3`remote-process` is an executable used to communicate with an instance of the
4parameter-framework through a TCP socket. It is only possible if the
5parameter-framework's configuration allows it (`TuningAllowed="true"` in the
6ParameterFrameworkConfiguration.xml) and if the port is also defined in the
7configuration (by the `ServerPort` attribute):
8
9For instance, if your parameter-framework configuration starts with:
10
11 <ParameterFrameworkConfiguration SystemClassName="..." ServerPort="5000" TuningAllowed="true">
12
13then, it listens on port 5000.
14
15remote-process may also be used to communicate with test-platform
16(see test/test-platform/README.md) thanks to test-platform being a minimal
17parameter-framework client.
18
19## Syntax
20
21 remote-process <hostname port|tcp://[host]:port|unix://path> <command>
22
23You can get all available commands with the `help` command.
24