A number of small changes I prefer to do in one shot: - Add a note about instability - Add multiple monitors example - Small clarifications
Signed-off-by: Luiz Capitulino <lcapitul...@redhat.com> --- QMP/README | 36 +++++++++++++++++++++++------------- 1 files changed, 23 insertions(+), 13 deletions(-) diff --git a/QMP/README b/QMP/README index 35a80c7..30a283b 100644 --- a/QMP/README +++ b/QMP/README @@ -7,13 +7,17 @@ Introduction The QEMU Monitor Protocol (QMP) allows applications to communicate with QEMU's Monitor. -QMP is JSON[1] based and has the following features: +QMP is JSON[1] based and currently has the following features: - Lightweight, text-based, easy to parse data format -- Asynchronous events support -- Stability +- Asynchronous messages support (ie. events) +- Capabilities Negotiation -For more information, please, refer to the following files: +However, QMP is still under heavy development and is considered an unstable +protocol. This means that its interface is going to have incompatible changes +between QEMU releases. We plan to make QMP stable as soon as possible. + +For more information on QMP's usage, please, refer to the following files: o qmp-spec.txt QEMU Monitor Protocol current specification o qmp-commands.txt QMP supported commands @@ -29,9 +33,8 @@ o vm-info Show some information about the Virtual Machine Usage ----- -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. +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: @@ -40,9 +43,17 @@ $ qemu [...] -qmp tcp:localhost:4444,server Will start QEMU in control mode, waiting for a client TCP connection on localhost port 4444. -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. +To have more complex combinations, like multiple monitors, the '-mon' +command-line option should be used with the '-chardev' one. For instance, the +following command-line creates one user monitor on stdio and one QMP monitor +on localhost port 4444. + +$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \ + -mon chardev=mon0,mode=readline \ + -chardev socket,id=mon1,host=localhost,port=4444,server \ + -mon chardev=mon1,mode=control + +Please, refer to QEMU's manpage for more information. Simple Testing -------------- @@ -59,8 +70,7 @@ Escape character is '^]'. { "execute": "query-version" } {"return": {"qemu": "0.12.50", "package": ""}} -Contact -------- +Homepage +-------- http://www.linux-kvm.org/page/MonitorProtocol -Luiz Fernando N. Capitulino <lcapitul...@redhat.com> -- 1.7.2.rc0