summaryrefslogtreecommitdiffstats
path: root/QMP
authorLuiz Capitulino <[email protected]>2009-12-18 15:25:02 (GMT)
committer Anthony Liguori <[email protected]>2009-12-19 14:26:02 (GMT)
commit052f1b9be56a97d429019f4a42ef680cbc378125 (patch) (side-by-side diff)
treee332ab0b26c62b11b086e482bff9119135ecb585 /QMP
parent3661d51e8d75710f95376c9383d0cd8042d51727 (diff)
downloadqemu-kvm-052f1b9be56a97d429019f4a42ef680cbc378125.zip
qemu-kvm-052f1b9be56a97d429019f4a42ef680cbc378125.tar.gz
qemu-kvm-052f1b9be56a97d429019f4a42ef680cbc378125.tar.bz2
QMP: Update README file
- Fix output description - Fix command-line usage notes - Minor improvements Signed-off-by: Luiz Capitulino <[email protected]> Signed-off-by: Anthony Liguori <[email protected]>
Diffstat (limited to 'QMP') (more/less context) (ignore whitespace changes)
-rw-r--r--QMP/README34
1 files changed, 23 insertions, 11 deletions
diff --git a/QMP/README b/QMP/README
index 50c31f2..09e7053 100644
--- a/QMP/README
+++ b/QMP/README
@@ -4,45 +4,57 @@
Introduction
-------------
-The QEMU Monitor Protocol (QMP) is a JSON[1] based protocol for QEMU.
+The QEMU Monitor Protocol (QMP) allows applications to communicate with
+QEMU's Monitor.
-By using it applications can control QEMU in reliable and "parseable" way,
-QMP also provides asynchronous events support.
+QMP is JSON[1] based and has the following features:
+
+- Lightweight, text-based, easy to parse data format
+- Asynchronous events support
+- Stability
For more information, please, refer to the following files:
-o qmp-spec.txt QEMU Monitor Protocol current draft specification
+o qmp-spec.txt QEMU Monitor Protocol current specification
o qmp-events.txt List of available asynchronous events
There are also two simple Python scripts available:
o qmp-shell A shell
-o vm-info Show some informations about the Virtal Machine
+o vm-info Show some information about the Virtual Machine
[1] http://www.json.org
Usage
-----
-To enable QMP, QEMU has to be started in "control mode". This is done
-by passing the flag "control" to the "-monitor" command-line option.
+To enable QMP, QEMU has to be started in "control mode". There are
+two ways of doing this, the simplest one is using the the '-qmp'
+command-line option.
For example:
-$ qemu [...] -monitor control,tcp:localhost:4444,server
+$ qemu [...] -qmp tcp:localhost:4444,server
Will start QEMU in control mode, waiting for a client TCP connection
on localhost port 4444.
-To manually test it you can connect with telnet and issue commands:
+It is also possible to use the '-mon' command-line option to have
+more complex combinations. Please, refer to the QEMU's manpage for
+more information.
+
+Simple Testing
+--------------
+
+To manually test QMP one can connect with telnet and issue commands:
$ telnet localhost 4444
-Trying ::1...
+Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
{"QMP": {"capabilities": []}}
{ "execute": "query-version" }
-{"return": "0.11.50"}
+{"return": {"qemu": "0.11.50", "package": ""}}
Contact
-------