Build system.

[virt-tools.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..8ad654e
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,48 @@
+virt-tools - virtual machine info and statistics
+Copyright (C) Red Hat Inc. 2009
+----------------------------------------------------------------------
+
+
+Requirements
+----------------------------------------------------------------------
+
+In the host:
+
+  Perl 5
+
+  Perl modules:
+
+   - Net::SNMP
+
+   - Sys::Virt (Perl bindings for libvirt)
+
+   - Sys::Guestfs (part of libguestfs) [optional]
+
+  pod2man (usually part of Perl)
+
+  libvirt
+
+  libguestfs
+
+  fping
+
+In the guest, for Unix/Linux guests:
+
+  net-snmp (a portable SNMP server, nothing to do with Perl Net::SNMP)
+
+
+Build and install
+----------------------------------------------------------------------
+
+To build and install on a Unix/Linux system you would do:
+
+  ./configure
+  make
+
+as root:
+
+  make install
+
+Note that this installs everything (client scripts which should be run
+on the host, and the service configuration which should be run in the
+guest).