From patchwork Tue Jul 6 22:19:16 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Capitulino X-Patchwork-Id: 58070 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id C0295B6EEE for ; Wed, 7 Jul 2010 08:20:38 +1000 (EST) Received: from localhost ([127.0.0.1]:51674 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OWGVG-0003C1-9g for incoming@patchwork.ozlabs.org; Tue, 06 Jul 2010 18:20:34 -0400 Received: from [140.186.70.92] (port=60282 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OWGUC-0003A4-0f for qemu-devel@nongnu.org; Tue, 06 Jul 2010 18:19:29 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OWGUA-0006kx-LU for qemu-devel@nongnu.org; Tue, 06 Jul 2010 18:19:27 -0400 Received: from mx1.redhat.com ([209.132.183.28]:7594) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OWGUA-0006kX-EU for qemu-devel@nongnu.org; Tue, 06 Jul 2010 18:19:26 -0400 Received: from int-mx05.intmail.prod.int.phx2.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.18]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id o66MJOe3025234 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 6 Jul 2010 18:19:24 -0400 Received: from localhost (vpn-226-161.phx2.redhat.com [10.3.226.161]) by int-mx05.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id o66MJN3M009632; Tue, 6 Jul 2010 18:19:24 -0400 From: Luiz Capitulino To: qemu-devel@nongnu.org Date: Tue, 6 Jul 2010 19:19:16 -0300 Message-Id: <1278454757-5493-2-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1278454757-5493-1-git-send-email-lcapitulino@redhat.com> References: <1278454757-5493-1-git-send-email-lcapitulino@redhat.com> X-Scanned-By: MIMEDefang 2.67 on 10.5.11.18 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. Cc: armbru@redhat.com Subject: [Qemu-devel] [PATCH 1/2] QMP: Update README file X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org 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 --- 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