From nobody Sun Apr 28 03:12:27 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
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 1521806167742587.5714623496075;
 Fri, 23 Mar 2018 04:56:07 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com
 [10.5.11.13])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 4BABDC00F7C0;
	Fri, 23 Mar 2018 11:56:06 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id DFADF611A5;
	Fri, 23 Mar 2018 11:56:05 +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 A2AD44CA9B;
	Fri, 23 Mar 2018 11:56:05 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com
	[10.11.54.3])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id w2NBu22N027286 for <libvir-list@listman.util.phx.redhat.com>;
	Fri, 23 Mar 2018 07:56:02 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 1F3F610B2B3F; Fri, 23 Mar 2018 11:56:02 +0000 (UTC)
Received: from antique-work.brq.redhat.com (unknown [10.43.2.152])
	by smtp.corp.redhat.com (Postfix) with ESMTP id BAB7110B2B2B
	for <libvir-list@redhat.com>; Fri, 23 Mar 2018 11:56:01 +0000 (UTC)
From: Pavel Hrdina <phrdina@redhat.com>
To: libvir-list@redhat.com
Date: Fri, 23 Mar 2018 12:55:57 +0100
Message-Id: 
 <f01f8efedf638e1e4bf83b7ebc99743ca19bc4ac.1521806118.git.phrdina@redhat.com>
In-Reply-To: <cover.1521806118.git.phrdina@redhat.com>
References: <cover.1521806118.git.phrdina@redhat.com>
In-Reply-To: <cover.1521806118.git.phrdina@redhat.com>
References: <cover.1521806118.git.phrdina@redhat.com>
X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH v2 1/2] docs: fix a typo in docs.html page
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.13
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]);
 Fri, 23 Mar 2018 11:56:06 +0000 (UTC)
X-ZohoMail: RSF_0  Z_629925259 SPT_0
Content-Type: text/plain; charset="utf-8"

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
Reviewed-by: Daniel P. Berrang=C3=A9 <berrange@redhat.com>
---
 docs/docs.html.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/docs.html.in b/docs/docs.html.in
index a8d544f83f..ee521c7460 100644
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -59,7 +59,7 @@
           <a href=3D"csharp.html">c#</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>.
+          <a href=3D"https://libvirt.org/ocaml/">ocaml</a>,
           <a href=3D"http://search.cpan.org/dist/Sys-Virt/">perl</a>,
           <a href=3D"python.html">python</a>,
           <a href=3D"php.html">php</a>,
--=20
2.14.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Sun Apr 28 03:12:27 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
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 1521806167837970.7879415264836;
 Fri, 23 Mar 2018 04:56:07 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com
 [10.5.11.13])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 2BF2B19CBF3;
	Fri, 23 Mar 2018 11:56:06 +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 E06EE611A7;
	Fri, 23 Mar 2018 11:56:05 +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 9ACC31806104;
	Fri, 23 Mar 2018 11:56:05 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com
	[10.11.54.3])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id w2NBu2ef027292 for <libvir-list@listman.util.phx.redhat.com>;
	Fri, 23 Mar 2018 07:56:02 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id B02E610B2B3F; Fri, 23 Mar 2018 11:56:02 +0000 (UTC)
Received: from antique-work.brq.redhat.com (unknown [10.43.2.152])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 57E2610B2B2B
	for <libvir-list@redhat.com>; Fri, 23 Mar 2018 11:56:02 +0000 (UTC)
From: Pavel Hrdina <phrdina@redhat.com>
To: libvir-list@redhat.com
Date: Fri, 23 Mar 2018 12:55:58 +0100
Message-Id: 
 <a985ecc250a7a494459d23014af939db884c474a.1521806118.git.phrdina@redhat.com>
In-Reply-To: <cover.1521806118.git.phrdina@redhat.com>
References: <cover.1521806118.git.phrdina@redhat.com>
In-Reply-To: <cover.1521806118.git.phrdina@redhat.com>
References: <cover.1521806118.git.phrdina@redhat.com>
X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH v2 2/2] 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.13
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]);
 Fri, 23 Mar 2018 11:56:06 +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>=20
---
 docs/bindings.html.in  |  13 ++++++-
 docs/dbus.html.in      | 102 +++++++++++++++++++++++++++++++++++++++++++++=
++++
 docs/docs.html.in      |   6 ++-
 docs/downloads.html.in |  15 ++++++++
 4 files changed, 133 insertions(+), 3 deletions(-)
 create mode 100644 docs/dbus.html.in

diff --git a/docs/bindings.html.in b/docs/bindings.html.in
index 733c89bc20..46930cd6f6 100644
--- a/docs/bindings.html.in
+++ b/docs/bindings.html.in
@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html xmlns=3D"http://www.w3.org/1999/xhtml">
   <body>
-    <h1 >Bindings for other languages</h1>
+    <h1 >Bindings for other languages and integration API modules</h1>
=20
     <p>
       Libvirt supports C and C++ directly, and has bindings available
@@ -74,6 +74,17 @@
       </li>
     </ul>
=20
+    <p>
+      Integration API modules:
+    </p>
+
+    <ul>
+      <li>
+        <strong>D-Bus</strong>: Pavel Hrdina develops
+        <a href=3D"dbus.html">D-Bus API</a>.
+      </li>
+    </ul>
+
     <p>
       For information on using libvirt on <strong>Windows</strong>
       <a href=3D"windows.html">please see the Windows support page</a>.
diff --git a/docs/dbus.html.in b/docs/dbus.html.in
new file mode 100644
index 0000000000..6ff71d2770
--- /dev/null
+++ b/docs/dbus.html.in
@@ -0,0 +1,102 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!DOCTYPE html>
+<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 ee521c7460..40e0e3b82e 100644
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -54,7 +54,7 @@
         <dt><a href=3D"virshcmdref.html">Virsh Commands</a></dt>
         <dd>Command reference for virsh</dd>
=20
-        <dt><a href=3D"bindings.html">Language bindings</a></dt>
+        <dt><a href=3D"bindings.html">Language bindings and API modules</a=
></dt>
         <dd>Bindings of the libvirt API for
           <a href=3D"csharp.html">c#</a>,
           <a href=3D"https://godoc.org/github.com/libvirt/libvirt-go">go</=
a>,
@@ -63,7 +63,9 @@
           <a href=3D"http://search.cpan.org/dist/Sys-Virt/">perl</a>,
           <a href=3D"python.html">python</a>,
           <a href=3D"php.html">php</a>,
-          <a href=3D"https://libvirt.org/ruby/">ruby</a></dd>
+          <a href=3D"https://libvirt.org/ruby/">ruby</a>
+          and integration API modules for
+          <a href=3D"dbus.html">D-Bus</a></dd>
=20
=20
         <dt><a href=3D"format.html">XML schemas</a></dt>
diff --git a/docs/downloads.html.in b/docs/downloads.html.in
index 7c28e2ba9b..8cca203e54 100644
--- a/docs/downloads.html.in
+++ b/docs/downloads.html.in
@@ -220,6 +220,21 @@
             <a href=3D"https://godoc.org/github.com/libvirt/libvirt-go-xml=
">api ref</a>
           </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>Console Proxy</td>
           <td>
--=20
2.14.3

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