From: Luiz Capitulino <lcapitulino@redhat.com>
To: qemu-devel@nongnu.org
Cc: aliguori@us.ibm.com
Subject: [Qemu-devel] [PATCH 4/7] QMP: Update README file
Date: Fri, 18 Dec 2009 13:25:02 -0200 [thread overview]
Message-ID: <1261149905-7622-5-git-send-email-lcapitulino@redhat.com> (raw)
In-Reply-To: <1261149905-7622-1-git-send-email-lcapitulino@redhat.com>
- Fix output description
- Fix command-line usage notes
- Minor improvements
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
---
QMP/README | 34 +++++++++++++++++++++++-----------
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
-------
--
1.6.6.rc3
next prev parent reply other threads:[~2009-12-18 15:25 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-12-18 15:24 [Qemu-devel] [FOR 0.12 0/7]: More QMP related fixes Luiz Capitulino
2009-12-18 15:24 ` [Qemu-devel] [PATCH 1/7] QMP: Only handle converted commands Luiz Capitulino
2009-12-18 15:25 ` [Qemu-devel] [PATCH 2/7] QMP: Return an empty dict by default Luiz Capitulino
2009-12-18 15:25 ` [Qemu-devel] [PATCH 3/7] QMP: Assure that returned data is a QDict Luiz Capitulino
2009-12-21 19:21 ` Nathan Baum
2009-12-22 3:06 ` Luiz Capitulino
2009-12-18 15:25 ` Luiz Capitulino [this message]
2009-12-18 15:25 ` [Qemu-devel] [PATCH 5/7] QMP: Update spec file Luiz Capitulino
2009-12-18 17:20 ` Markus Armbruster
2009-12-18 17:44 ` Anthony Liguori
2009-12-18 17:48 ` Luiz Capitulino
2009-12-18 18:06 ` Markus Armbruster
2009-12-18 18:08 ` Luiz Capitulino
2009-12-18 17:55 ` Luiz Capitulino
2009-12-18 18:38 ` Markus Armbruster
2009-12-18 15:25 ` [Qemu-devel] [PATCH 6/7] monitor: Introduce 'M' argument type Luiz Capitulino
2009-12-18 15:25 ` [Qemu-devel] [PATCH 7/7] monitor: do_balloon(): Use " Luiz Capitulino
2009-12-18 17:25 ` [Qemu-devel] [FOR 0.12 0/7]: More QMP related fixes Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1261149905-7622-5-git-send-email-lcapitulino@redhat.com \
--to=lcapitulino@redhat.com \
--cc=aliguori@us.ibm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).