ruby-libvirt
============

Ruby bindings for libvirt (http://libvirt.org)

Usage
-----

In your ruby code, do a "require 'libvirt'"; to obtain a connection, use
'Libvirt::open' or 'Libvirt::open_read_only'. See tests/*.rb for more
examples.

Hacking
-------

On a Fedora machine, run
  yum install libvirt-devel ruby-devel rubygem-rake
and then
  rake build
  rake test

To run against the checkout, make sure you set RUBYLIB (assuming DIR is the
toplevel of your source checkout):

  export RUBYLIB=$dir/lib:$dir/ext/libvirt
  ruby -rlibvirt -e 'puts Libvirt::version[0]'

Notes
-----
As of December 12, 2010, the ruby-libvirt bindings support all of the libvirt
APIs up to libvirt commit hash e8d05c978da774b7abbbc38dfcc00b9b582fdf72
with the following exceptions:

- virConnectRef
- virDomainGetConnect
- virDomainRef
- virDomainSetMemoryParameters
- virDomainGetMemoryParameters
- virDomainIsUpdated
- virDomainOpenConsole
- virNetworkGetConnect
- virNetworkRef
- virInterfaceGetConnect
- virInterfaceRef
- virStoragePoolGetConnect
- virStoragePoolRef
- virStorageVolGetConnect
- virStorageVolRef
- virNodeDeviceRef
- virSecretGetConnect
- virSecretRef
- virStreamNew
- virStreamRef
- virStreamSend
- virStreamRecv
- virStreamSendAll
- virStreamRecvAll
- virStreamEventAddCallback
- virStreamEventUpdateCallback
- virStreamEventRemoveCallback
- virStreamFinish
- virStreamAbort
- virStreamFree
- virNWFilterRef
