summaryrefslogtreecommitdiffstats
path: root/perl/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/README')
-rw-r--r--perl/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/perl/README b/perl/README
new file mode 100644
index 00000000..6d7d6460
--- /dev/null
+++ b/perl/README
@@ -0,0 +1,20 @@
+Sys::Guestfs
+------------
+
+This directory contains the Perl bindings for the libguestfs API.
+
+The basic libguestfs bindings have the name 'Sys::Guestfs'.
+
+As with all other language bindings, these bindings are generated
+automatically. See src/generator.ml.
+
+Sys::Guestfs::Lib
+-----------------
+
+Because we use Perl for writing lots of additional tools around
+libguestfs, the Perl bindings also contain an extra library of useful
+functions, called 'Sys::Guestfs::Lib'. This extra library is entirely
+optional, and only enhances the usefulness of the ordinary libguestfs
+API.
+
+One of the features of this library is tighter libvirt integration.