git.annexia.org / libguestfs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
inspect: Refuse to download software hive if it is huge.
[libguestfs.git] / README
diff --git a/README b/README
index ad04884..5a0b59c 100644 (file)
--- a/README
+++ b/README
@@ -13,11 +13,12 @@ schemes, qcow, qcow2, vmdk.
 
 Libguestfs provides ways to enumerate guest storage (eg. partitions,
 LVs, what filesystem is in each LV, etc.).  It can also run commands
 
 Libguestfs provides ways to enumerate guest storage (eg. partitions,
 LVs, what filesystem is in each LV, etc.).  It can also run commands
-in the context of the guest.  Also you can access filesystems over FTP.
+in the context of the guest.  Also you can access filesystems over
+FUSE.
 
 Libguestfs is a library that can be linked with C and C++ management
 programs (or management programs written in OCaml, Perl, Python, Ruby,
 
 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
 command line.
 
 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com) and
@@ -36,10 +37,9 @@ Home page
 Requirements
 ----------------------------------------------------------------------
 
 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.3
+- febootstrap >= 2.10
 
 - fakeroot
 
 
 - fakeroot
 
@@ -47,29 +47,35 @@ Requirements
 
 - XDR, rpcgen (on Linux these are provided by glibc)
 
 
 - XDR, rpcgen (on Linux these are provided by glibc)
 
+- pcre (Perl Compatible Regular Expressions C library) (optional)
+
+- libmagic (the library that corresponds to the 'file' command) (optional)
+
+- libvirt (optional)
+
+- libxml2 (optional)
+
+- Augeas (http://augeas.net/) (optional)
+
+- gperf
+
 - squashfs-tools (mksquashfs only)
 
 - genisoimage / mkisofs
 
 - squashfs-tools (mksquashfs only)
 
 - genisoimage / mkisofs
 
-- libxml2
+- hivex >= 1.2.1 (http://libguestfs.org/download)
 
 - (Optional) FUSE to build the FUSE module
 
 
 - (Optional) FUSE to build the FUSE module
 
-- (Optional) Augeas (http://augeas.net/)
-
 - perldoc (pod2man, pod2text) to generate the manual pages and
   other documentation.
 
 - (Optional) Readline to have nicer command-line editing in guestfish.
 
 - perldoc (pod2man, pod2text) to generate the manual pages and
   other documentation.
 
 - (Optional) Readline to have nicer command-line editing in guestfish.
 
-- (Optional) 'reged' program from chntpw to decode Windows registry
-  entries (http://home.eunet.no/~pnordahl/ntpasswd/)
-
 - (Optional) xmllint to validate virt-inspector RELAX NG schema
 
 - (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
 
 
 - (Optional) local Fedora mirror
 
@@ -89,6 +95,10 @@ in virt-inspector).
 
 - (Optional, but highly recommended) perl-libintl for translating perl code.
 
 
 - (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.
 
 Running ./configure will check you have all the requirements installed
 on your machine.
 
@@ -204,10 +214,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.
 
 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
 
 
 Supermin appliance
@@ -271,8 +279,8 @@ Notes on cross-architecture support
 
 At the moment we basically don't support cross-architecture or
 32-on-64.  This limits what is possible for some guests.  Filesystem
 
 At the moment we basically don't support cross-architecture or
 32-on-64.  This limits what is possible for some guests.  Filesystem
-operations and FTP export will work fine, but running commands in
-guests may not be possible.
+operations and FUSE will work fine, but running commands in guests may
+not be possible.
 
 To enable this requires work for cross-architecture and 32-on-64
 support in febootstrap, fakeroot and fakechroot.
 
 To enable this requires work for cross-architecture and 32-on-64
 support in febootstrap, fakeroot and fakechroot.
@@ -317,13 +325,13 @@ first:
  - python
  - rpm-python    http://www.rpm.org/
  - yum           http://yum.baseurl.org/
  - python
  - rpm-python    http://www.rpm.org/
  - yum           http://yum.baseurl.org/
- - febootstrap   http://et.redhat.com/~rjones/febootstrap/
+ - febootstrap   http://people.redhat.com/~rjones/febootstrap/
 
 
 Copyright and license information
 ----------------------------------------------------------------------
 
 
 
 Copyright and license information
 ----------------------------------------------------------------------
 
-Copyright (C) 2009 Red Hat Inc.
+Copyright (C) 2009-2010 Red Hat Inc.
 
 The library is distributed under the LGPLv2+.  The programs are
 distributed under the GPLv2+.  Please see the files COPYING and
 
 The library is distributed under the LGPLv2+.  The programs are
 distributed under the GPLv2+.  Please see the files COPYING and
[MOVED TO GITHUB] library for accessing and modifying guest disk images