From nobody Mon Apr 29 22:25:28 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
Return-Path: <libvir-list-bounces@redhat.com>
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1521790542838526.280790177905;
 Fri, 23 Mar 2018 00:35:42 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
 [10.5.11.16])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id BFCC220264;
	Fri, 23 Mar 2018 07:35:40 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id EE7B45E1C3;
	Fri, 23 Mar 2018 07:35:38 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 28A561806104;
	Fri, 23 Mar 2018 07:35:37 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com
	[10.11.54.4])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id w2N7ZZIR029118 for <libvir-list@listman.util.phx.redhat.com>;
	Fri, 23 Mar 2018 03:35:35 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id AC5912023233; Fri, 23 Mar 2018 07:35:35 +0000 (UTC)
Received: from antique-work.brq.redhat.com (unknown [10.43.2.152])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 522682023231
	for <libvir-list@redhat.com>; Fri, 23 Mar 2018 07:35:35 +0000 (UTC)
From: Pavel Hrdina <phrdina@redhat.com>
To: libvir-list@redhat.com
Date: Fri, 23 Mar 2018 08:35:34 +0100
Message-Id: 
 <16b4a3cb9be52041780656640038f820a84c129e.1521790489.git.phrdina@redhat.com>
X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH] docs: introduce libvirt-dbus binding
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	<libvir-list.redhat.com>
List-Unsubscribe: <https://www.redhat.com/mailman/options/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=unsubscribe>
List-Archive: <https://www.redhat.com/archives/libvir-list>
List-Post: <mailto:libvir-list@redhat.com>
List-Help: <mailto:libvir-list-request@redhat.com?subject=help>
List-Subscribe: <https://www.redhat.com/mailman/listinfo/libvir-list>,
	<mailto:libvir-list-request@redhat.com?subject=subscribe>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]);
 Fri, 23 Mar 2018 07:35:41 +0000 (UTC)
X-ZohoMail: RSF_0  Z_629925259 SPT_0
Content-Type: text/plain; charset="utf-8"

libvirt-dbus is a new binding that wraps libvirt API into D-Bus calls.

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
Reviewed-by: Daniel P. Berrang=C3=A9 <berrange@redhat.com>
---
 docs/bindings.html.in  |   4 ++
 docs/dbus.html.in      | 102 +++++++++++++++++++++++++++++++++++++++++++++=
++++
 docs/docs.html.in      |   1 +
 docs/downloads.html.in |  15 ++++++++
 4 files changed, 122 insertions(+)
 create mode 100644 docs/dbus.html.in

diff --git a/docs/bindings.html.in b/docs/bindings.html.in
index 733c89bc20..236bdcf2ae 100644
--- a/docs/bindings.html.in
+++ b/docs/bindings.html.in
@@ -18,6 +18,10 @@
         <strong>Go</strong>: Daniel Berrange develops
         <a href=3D"https://godoc.org/github.com/libvirt/libvirt-go">Go bin=
dings</a>.
       </li>
+      <li>
+        <strong>D-Bus</strong>: Pavel Hrdina develops
+        <a href=3D"dbus.html">D-Bus bindings</a>.
+      </li>
       <li>
         <strong>Java</strong>: Daniel Veillard develops
         <a href=3D"java.html">Java bindings</a>.
diff --git a/docs/dbus.html.in b/docs/dbus.html.in
new file mode 100644
index 0000000000..0da8096122
--- /dev/null
+++ b/docs/dbus.html.in
@@ -0,0 +1,102 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.or=
g/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns=3D"http://www.w3.org/1999/xhtml">
+  <body>
+    <h1>D-Bus API bindings</h1>
+
+    <ul id=3D"toc"></ul>
+
+    <h2><a name=3D"description">Description</a></h2>
+
+    <p>
+      libvirt-dbus wraps libvirt API to provide a high-level object-orient=
ed
+      API better suited for dbus-based applications.
+    </p>
+
+    <h2><a name=3D"git">GIT source repository</a></h2>
+    <p>
+      The D-Bus bindings source code is maintained in a
+      <a href=3D"https://git-scm.com/">git</a> repository available on
+      <a href=3D"https://libvirt.org/git/">libvirt.org</a>:
+    </p>
+
+<pre>
+git clone https://libvirt.org/git/libvirt-dbus.git
+</pre>
+
+    <p>
+      They can also be browsed online:
+    </p>
+
+<pre>
+<a href=3D"https://libvirt.org/git/?p=3Dlibvirt-dbus.git">https://libvirt.=
org/git/?p=3Dlibvirt-dbus.git</a>
+</pre>
+
+    <h2><a name=3D"usage">Usage</a></h2>
+
+    <p>
+      libvirt-dbus exports libvirt API using D-Bus objects with methods and
+      properties described by interfaces.  Currently only local connection
+      to libvirt is exported and the list of supported drivers depends
+      on the type of the bus connection (session or system).
+    </p>
+
+    <p>
+      The name of the libvirt-dbus service is <code>org.libvirt</code>.
+      libvirt-dbus distributes an interface XML descriptions which can be
+      usually found at <code>/usr/share/dbus-1/interfaces/</code>.
+    </p>
+
+    <p>
+      By default unprivileged user has access only to the session D-Bus
+      connection. In order to allow specific user "foo" to access the syst=
em
+      D-Bus connection you need to create a file
+      <code>/etc/dbus-1/system.d/org.libvirt.conf</code> that contains:
+    </p>
+
+<pre>
+&lt;?xml version=3D"1.0"?&gt;
+&lt;!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-BUS Bus Configuration=
 1.0//EN"
+ "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"&gt;
+
+&lt;busconfig&gt;
+
+  &lt;policy user=3D"foo"&gt;
+    &lt;allow send_destination=3D"org.libvirt"/&gt;
+  &lt;/policy&gt;
+
+&lt;/busconfig&gt;
+</pre>
+
+    <p>
+      To get a list of supported drivers for the specific bus connection
+      you can run these commands (not all drivers may be available on
+      the host):
+    </p>
+
+<pre>
+gdbus introspect --xml --session --dest org.libvirt --object-path /org/lib=
virt
+gdbus introspect --xml --system --dest org.libvirt --object-path /org/libv=
irt
+</pre>
+
+    <p>
+      Every object is introspectable so you can get a list of available
+      interfaces with methods, signals and properties running this command:
+    </p>
+
+<pre>
+gdbus introspect --xml --system --dest org.libvirt --object-path /org/libv=
irt/QEMU
+</pre>
+
+    <p>
+      To get a list of domains for specific connection driver you can run
+      this command:
+    </p>
+
+<pre>
+gdbus call --system --dest org.libvirt --object-path /org/libvirt/QEMU \
+    --method org.libvirt.Connect.ListDomains 0
+</pre>
+
+  </body>
+</html>
diff --git a/docs/docs.html.in b/docs/docs.html.in
index a8d544f83f..abd344ca2e 100644
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -57,6 +57,7 @@
         <dt><a href=3D"bindings.html">Language bindings</a></dt>
         <dd>Bindings of the libvirt API for
           <a href=3D"csharp.html">c#</a>,
+          <a href=3D"dbus.html">D-Bus</a>,
           <a href=3D"https://godoc.org/github.com/libvirt/libvirt-go">go</=
a>,
           <a href=3D"java.html">java</a>,
           <a href=3D"https://libvirt.org/ocaml/">ocaml</a>.
diff --git a/docs/downloads.html.in b/docs/downloads.html.in
index 7c28e2ba9b..c2bc7af3e9 100644
--- a/docs/downloads.html.in
+++ b/docs/downloads.html.in
@@ -60,6 +60,21 @@
           </td>
           <td></td>
         </tr>
+        <tr>
+          <td>D-Bus</td>
+          <td>
+            <a href=3D"ftp://libvirt.org/libvirt/dbus/">ftp</a>
+            <a href=3D"https://libvirt.org/sources/dbus/">https</a>
+          </td>
+          <td>
+            <a href=3D"https://libvirt.org/git/?p=3Dlibvirt-dbus.git;a=3Ds=
ummary">libvirt</a>
+          </td>
+          <td>
+            <a href=3D"https://gitlab.com/libvirt/libvirt-dbus">gitlab</a>
+            <a href=3D"https://github.com/libvirt/libvirt-dbus">github</a>
+          </td>
+          <td></td>
+        </tr>
         <tr>
           <td>Go</td>
           <td>
--=20
2.14.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list