summaryrefslogtreecommitdiffstats
path: root/remote-process
diff options
context:
space:
mode:
authorDavid Wagner <david.wagner@intel.com>2014-03-06 14:58:29 +0100
committerDavid Wagner <david.wagner@intel.com>2014-09-10 12:04:36 +0200
commitf811b7b53c0c2f0d4320c70230e609619c5087c1 (patch)
treee96266eb13098f5a82aef2d3079b626653706dd2 /remote-process
parente8088d0f60d895a733c00953c0fdd4e9daf0b279 (diff)
downloadexternal_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.zip
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.gz
external_parameter-framework-f811b7b53c0c2f0d4320c70230e609619c5087c1.tar.bz2
More README files
- More details in the root README.md file; add a nice diagram - Add a lot of README files in subdirectories Signed-off-by: David Wagner <david.wagner@intel.com>
Diffstat (limited to 'remote-process')
-rw-r--r--remote-process/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/remote-process/README.md b/remote-process/README.md
new file mode 100644
index 0000000..128dc3f
--- /dev/null
+++ b/remote-process/README.md
@@ -0,0 +1,31 @@
+# remote-process
+
+`remote-process` is an executable used to communicate with an instance of the
+parameter-framework through a TCP socket. It is only possible if the
+parameter-framework's configuration allows it (`TuningAllowed="true"` in the
+ParameterFrameworkConfiguration.xml) and if the port is also defined in the
+configuration (by the `ServerPort` attribute):
+
+For instance, if your parameter-framework configuration starts with:
+
+ <ParameterFrameworkConfiguration SystemClassName="..." ServerPort="5000" TuningAllowed="true">
+
+then, it listens on port 5000.
+
+remote-process may also be used to communicate with test-platform
+(see test/test-platform/README.md) thanks to test-platform being a minimal
+parameter-framework client.
+
+## Syntax
+
+ remote-process <host> <port> <command>
+
+You can get all available commands with the `help` command.
+
+You may also run a batch of commands by passing them on remote-process'
+standard input:
+
+ remote-process <host> <port> < file
+
+You should not use this feature in an interactive mode, because the
+communication may timeout if you're typing your commands too slowly.