QMP: Update README file

- Fix output description
- Fix command-line usage notes
- Minor improvements

Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
This commit is contained in:
Luiz Capitulino 2009-12-18 13:25:02 -02:00 committed by Anthony Liguori
parent 3661d51e8d
commit 052f1b9be5

View file

@ -4,45 +4,57 @@
Introduction 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 is JSON[1] based and has the following features:
QMP also provides asynchronous events support.
- Lightweight, text-based, easy to parse data format
- Asynchronous events support
- Stability
For more information, please, refer to the following files: 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 o qmp-events.txt List of available asynchronous events
There are also two simple Python scripts available: There are also two simple Python scripts available:
o qmp-shell A shell 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 [1] http://www.json.org
Usage Usage
----- -----
To enable QMP, QEMU has to be started in "control mode". This is done To enable QMP, QEMU has to be started in "control mode". There are
by passing the flag "control" to the "-monitor" command-line option. two ways of doing this, the simplest one is using the the '-qmp'
command-line option.
For example: 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 Will start QEMU in control mode, waiting for a client TCP connection
on localhost port 4444. 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 $ telnet localhost 4444
Trying ::1... Trying 127.0.0.1...
Connected to localhost. Connected to localhost.
Escape character is '^]'. Escape character is '^]'.
{"QMP": {"capabilities": []}} {"QMP": {"capabilities": []}}
{ "execute": "query-version" } { "execute": "query-version" }
{"return": "0.11.50"} {"return": {"qemu": "0.11.50", "package": ""}}
Contact Contact
------- -------