build: Centralize all POD manipulation in 'podwrapper.sh' script.

[libguestfs.git] / README

diff --git a/README b/README
index b31f9a1..57021e9 100644 (file)
--- a/README
+++ b/README
@@ -18,7 +18,7 @@ FUSE.
 
 Libguestfs is a library that can be linked with C and C++ management
 programs (or management programs written in OCaml, Perl, Python, Ruby,
-Java, Haskell or C#).  You can also use it from shell scripts or the
+Java, PHP, Haskell or C#).  You can also use it from shell scripts or the
 command line.
 
 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com) and
@@ -37,10 +37,9 @@ Home page
 Requirements
 ----------------------------------------------------------------------
 
-- recent QEMU >= 0.10 with vmchannel support
-  http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
+- recent QEMU >= 0.12 with virtio-serial support
 
-- febootstrap >= 2.8
+- febootstrap >= 2.10
 
 - fakeroot
 
@@ -48,34 +47,38 @@ Requirements
 
 - XDR, rpcgen (on Linux these are provided by glibc)
 
-- pcre (Perl Compatible Regular Expressions C library)
+- pcre (Perl Compatible Regular Expressions C library) (optional)
+
+- libmagic (the library that corresponds to the 'file' command) (optional)
+
+- libvirt (optional)
 
-- libmagic (the library that corresponds to the 'file' command)
+- libxml2 (optional)
 
-- libvirt
+- Augeas (http://augeas.net/) (optional)
 
-- libxml2
+- gperf
 
 - squashfs-tools (mksquashfs only)
 
 - genisoimage / mkisofs
 
-- (Optional) hivex >= 1.2.1 to build Windows Registry support
+- hivex >= 1.2.1 (http://libguestfs.org/download)
 
-- (Optional) FUSE to build the FUSE module
+- (Optional) Berkeley DB 'db_dump' and 'db_load' utilities
+  (db4-utils or db4.X-util or similar)
 
-- (Optional) Augeas (http://augeas.net/)
+- (Optional) FUSE to build the FUSE module
 
-- perldoc (pod2man, pod2text) to generate the manual pages and
-  other documentation.
+- perldoc (pod2man, pod2text, pod2html) to generate the manual pages
+  and other documentation.
 
 - (Optional) Readline to have nicer command-line editing in guestfish.
 
 - (Optional) xmllint to validate virt-inspector RELAX NG schema
 
-- (Optional) OCaml + OCaml library xml-light if you want to rebuild
-  the generated files, and also to build the OCaml bindings
-  (http://tech.motion-twin.com/xmllight.html)
+- (Optional) OCaml if you want to rebuild the generated files, and
+  also to build the OCaml bindings
 
 - (Optional) local Fedora mirror
 
@@ -90,11 +93,22 @@ bindings
 
 - (Optional) GHC if you want to build the Haskell bindings
 
-- (Optional) Perl XML::XPath, Sys::Virt modules (for libvirt support
-in virt-inspector).
+- (Optional) Perl Sys::Virt module.
+
+- (Optional) Perl Win::Hivex module.
+
+- (Optional) Perl Pod::Usage module.
+
+- (Optional) Perl Test::More module (from perl Test::Simple).
+
+- (Optional) Perl String::ShellQuote module.
 
 - (Optional, but highly recommended) perl-libintl for translating perl code.
 
+- (Optional) po4a for translating manpages and POD files.
+
+- (Optional) PHP, phpize if you want to build the PHP bindings
+
 Running ./configure will check you have all the requirements installed
 on your machine.
 
@@ -210,10 +224,8 @@ In libguestfs >= 1.0.71 we don't require any vmchannel implementation,
 as long as qemu has been compiled with support for SLIRP (user mode
 networking, or "-net user"), which is almost always the case.
 
-However we still offer the ability to use vmchannel, and in future we
-may add support for other types of qemu, which is useful in a few
-cases, specifically where qemu packagers decide to compile out support
-for SLIRP (qemu packagers: please don't do this).
+In libguestfs >= 1.5.4 we switched again to using qemu's virtio-serial
+and removed all the other vmchannels and the SLIRP channel.
 
 
 Supermin appliance