libvirt/docs/bindings.html.in

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <body>
    <h1 >Bindings for other languages and integration API modules</h1>

    <p>
      Libvirt supports C and C++ directly, and has bindings available
      for other languages:
    </p>

    <ul>
      <li>
        <strong>C#</strong>: Arnaud Champion develops
        <a href="csharp.html">C# bindings</a>.
      </li>
     <li>
        <strong>Go</strong>: Daniel Berrange develops
        <a href="https://godoc.org/libvirt.org/libvirt-go">Go bindings</a>.
      </li>
      <li>
        <strong>Java</strong>: Daniel Veillard develops
        <a href="java.html">Java bindings</a>.
      </li>
      <li>
        <strong>OCaml</strong>: Richard Jones develops
        <a href="https://libvirt.org/ocaml/">OCaml bindings</a>.
      </li>
      <li>
        <strong>Perl</strong>: Daniel Berrange develops
        <a href="http://search.cpan.org/dist/Sys-Virt/">Perl bindings</a>.
      </li>
      <li>
        <p>
          <strong>PHP</strong>: Radek Hladik started developing
          <a href="https://libvirt.org/php">PHP bindings</a> in 2010.
        </p>
        <p>
          In February 2011 the binding development has been moved to the libvirt.org website as
          libvirt-php project.
        </p>
        <p>
          The project is now maintained by Michal Novotny and it's heavily based
          on Radek's version. For more information, including
          information on posting patches to libvirt-php, please refer
          to the <a href="https://libvirt.org/php">PHP bindings</a> site.
        </p>
      </li>
      <li>
        <p>
          <strong>Python</strong>: Libvirt's python bindings are split to a
          separate <a href="https://gitlab.com/libvirt/libvirt-python">package</a>
          since version 1.2.0, older versions came with direct support for the
          Python language.
        </p>
        <p>
          If your libvirt is installed as packages, rather than compiled
          by you from source code, ensure you have the appropriate
          package installed.
        </p>
        <p>
          This is named <b>libvirt-python</b> on RHEL/Fedora,
          <a href="http://packages.ubuntu.com/search?keywords=python-libvirt"><b>python-libvirt</b></a>
          on Ubuntu, and may be named differently on others.
        </p>
        <p>
          For usage information, see the
          <a href="python.html">Python API bindings</a> page.
        </p>
      </li>
      <li>
        <strong>Ruby</strong>: Chris Lalancette develops
        <a href="https://libvirt.org/ruby/">Ruby bindings</a>.
      </li>
    </ul>

    <p>
      Integration API modules:
    </p>

    <ul>
      <li>
        <strong>D-Bus</strong>: Pavel Hrdina develops
        <a href="dbus.html">D-Bus API</a>.
      </li>
    </ul>

    <p>
      For information on using libvirt on <strong>Windows</strong>
      <a href="windows.html">please see the Windows support page</a>.
    </p>

    <p>
      Support, requests or help for libvirt bindings are welcome on the
      <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing list</a>,
      as usual try to provide enough background information and make sure
      you use recent version, see the <a href="bugs.html">help page</a>.
    </p>

  </body>
</html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 18:25:37 +04:00			`<?xml version="1.0" encoding="UTF-8"?>`
docs: switch to using HTML5 doctype declaration The HTML5 doctype is simply <!DOCTYPE html> no DTD is present because HTML5 is no longer defined as an extension of SGML. XSL has no way to natively output a doctype without a public or system identifier, so we have to use an <xsl:text> hack instead. See also https://dev.w3.org/html5/html-author/#doctype-declaration Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-07-26 20:01:25 +03:00			`<!DOCTYPE html>`
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2013-05-03 18:25:37 +04:00			`<html xmlns="http://www.w3.org/1999/xhtml">`
Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`<body>`
docs: introduce libvirt-dbus binding libvirt-dbus is a new binding that wraps libvirt API into D-Bus calls. Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com> 2017-07-04 17:50:00 +03:00			`<h1 >Bindings for other languages and integration API modules</h1>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00
			`<p>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`Libvirt supports C and C++ directly, and has bindings available`
			`for other languages:`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</p>`

Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`<ul>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<strong>C#</strong>: Arnaud Champion develops`
			`<a href="csharp.html">C# bindings</a>.`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
docs: Add libvirt-go Go bindings to binding page Signed-off-by: Roman Mohr <rmohr@redhat.com> 2016-09-06 13:47:45 +03:00			`<li>`
Point to the new libvirt-go bindings The github.com/rgbkrk/libvirt-go bindings were the most complete bindings historically, but their API coverage stops at 1.2.4, with exception of a couple of newer APIs. The new bindings at http://libvirt.org/git/?p=libvirt-go.git;a=log how have (almost[1]) 100% API coverage all the way to 2.5.0. They also expose the APIs in a way that allows for much stronger go type checking by the compiler, and expose typed parameters as explicit structs. Finally the bindings are able to conditionally compile against any libvirt version 1.2.0 -> 2.5.0 without use of go build tags. Change the docs to point to these new bindings, since they'll be a better bet for users long term. [1] virEvent & virStream callbacks are still TODO to be fixed real soon. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2016-12-13 20:05:16 +03:00			`<strong>Go</strong>: Daniel Berrange develops`
docs: Use libvirt.org namespace for Go bindings Fixes: 193ad364062407c3fcd3267f0f135d8960b53020 Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> 2020-07-07 13:42:01 +03:00			`<a href="https://godoc.org/libvirt.org/libvirt-go">Go bindings</a>.`
docs: Add libvirt-go Go bindings to binding page Signed-off-by: Roman Mohr <rmohr@redhat.com> 2016-09-06 13:47:45 +03:00			`</li>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<strong>Java</strong>: Daniel Veillard develops`
			`<a href="java.html">Java bindings</a>.`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<strong>OCaml</strong>: Richard Jones develops`
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-10-13 18:30:41 +03:00			`<a href="https://libvirt.org/ocaml/">OCaml bindings</a>.`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<strong>Perl</strong>: Daniel Berrange develops`
			`<a href="http://search.cpan.org/dist/Sys-Virt/">Perl bindings</a>.`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<p>`
Add libvirt-php information page This adds a ibvirt-php information page with some basic information on libvirt-php project compilation, contribution and other useful information. 2011-02-09 04:43:09 +03:00			`<strong>PHP</strong>: Radek Hladik started developing`
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-10-13 18:30:41 +03:00			`<a href="https://libvirt.org/php">PHP bindings</a> in 2010.`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`</p>`
			`<p>`
docs: Add information about libvirt-php new location Signed-off-by: Michal Novotny <minovotn@redhat.com> 2011-02-09 21:44:03 +03:00			`In February 2011 the binding development has been moved to the libvirt.org website as`
			`libvirt-php project.`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`</p>`
			`<p>`
Add libvirt-php information page This adds a ibvirt-php information page with some basic information on libvirt-php project compilation, contribution and other useful information. 2011-02-09 04:43:09 +03:00			`The project is now maintained by Michal Novotny and it's heavily based`
docs: Add information about libvirt-php new location Signed-off-by: Michal Novotny <minovotn@redhat.com> 2011-02-09 21:44:03 +03:00			`on Radek's version. For more information, including`
			`information on posting patches to libvirt-php, please refer`
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-10-13 18:30:41 +03:00			`to the <a href="https://libvirt.org/php">PHP bindings</a> site.`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`</p>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
			`<li>`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`<p>`
docs: Fix docs about python bindings package Since the day we removed python bindings from the core repository, the documentation was missing that information. Reported-by: Lingyu Zhu <lynuszhu@gmail.com> Signed-off-by: Martin Kletzander <mkletzan@redhat.com> 2015-01-19 13:03:55 +03:00			`<strong>Python</strong>: Libvirt's python bindings are split to a`
docs: point to GitLab as the primary git hosting We still point to git repositories hosted on libvirt.org in various places. Replace the links to their gitlab.com equivalents. Note that GitLab is trying to be smart here and https://gitlab.com/libvirt/libvirt redirects to https://gitlab.com/libvirt/libvirt.git when doing a 'git clone' and vice-versa when visiting from the browser, so I only kept the .git suffix in places that explicitly mentioned 'git clone'. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> 2020-06-03 13:42:34 +03:00			`separate <a href="https://gitlab.com/libvirt/libvirt-python">package</a>`
docs: Fix docs about python bindings package Since the day we removed python bindings from the core repository, the documentation was missing that information. Reported-by: Lingyu Zhu <lynuszhu@gmail.com> Signed-off-by: Martin Kletzander <mkletzan@redhat.com> 2015-01-19 13:03:55 +03:00			`since version 1.2.0, older versions came with direct support for the`
			`Python language.`
docs: reworded and reordered the bindings page, plus minor tweaks Reordered the bindings into alphabetical order, added a link to the php-libvirt source on Github, plus gave the direct package names needed for Python usage on RHEL/Fedora, and Ubuntu. 2010-10-27 07:17:38 +04:00			`</p>`
			`<p>`
			`If your libvirt is installed as packages, rather than compiled`
			`by you from source code, ensure you have the appropriate`
			`package installed.`
			`</p>`
			`<p>`
			`This is named <b>libvirt-python</b> on RHEL/Fedora,`
			`<a href="http://packages.ubuntu.com/search?keywords=python-libvirt"><b>python-libvirt</b></a>`
			`on Ubuntu, and may be named differently on others.`
			`</p>`
			`<p>`
			`For usage information, see the`
			`<a href="python.html">Python API bindings</a> page.`
			`</p>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
			`<li>`
docs: update ruby bindings maintainer to chris lalancette 2010-10-28 02:34:04 +04:00			`<strong>Ruby</strong>: Chris Lalancette develops`
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> 2017-10-13 18:30:41 +03:00			`<a href="https://libvirt.org/ruby/">Ruby bindings</a>.`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`</li>`
Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`</ul>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00
docs: introduce libvirt-dbus binding libvirt-dbus is a new binding that wraps libvirt API into D-Bus calls. Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com> 2017-07-04 17:50:00 +03:00			`<p>`
			`Integration API modules:`
			`</p>`

			`<ul>`
			`<li>`
			`<strong>D-Bus</strong>: Pavel Hrdina develops`
			`<a href="dbus.html">D-Bus API</a>.`
			`</li>`
			`</ul>`

docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00			`<p>`
			`For information on using libvirt on <strong>Windows</strong>`
			`<a href="windows.html">please see the Windows support page</a>.`
			`</p>`

			`<p>`
			`Support, requests or help for libvirt bindings are welcome on the`
			`<a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing list</a>,`
			`as usual try to provide enough background information and make sure`
			`you use recent version, see the <a href="bugs.html">help page</a>.`
Documentation cleanups. * docs/bindings.html.in: Clean up the bindings page, and add C# and Java. * docs/windows.html.in: Remove old bogus information and add placeholder. 2008-09-18 13:00:10 +04:00			`</p>`
docs: reformated the bindings page html markup to match other pages 2010-10-24 01:06:01 +04:00
Split website out into one file per page. APply new layout and styling 2008-04-23 21:08:31 +04:00			`</body>`
			`</html>`