X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=README;h=3e4da74dc21e41d5eecba3f29e3a7b11f90fc046;hp=a017249f3339712451c7e0d5dee09c5fc16afadf;hb=3906e4ff91c208e0ae90ab8b18e69e678a9bed8e;hpb=863d13ea1aadddc122ad82f4dad20e73231b48f2

diff --git a/README b/README
index a017249..3e4da74 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-libguestfs is a library for accessing and modifying guest disk images.
+Libguestfs is a library for accessing and modifying guest disk images.
 Amongst the things this is good for: making batch configuration
 changes to guests, getting disk used/free statistics (see also:
 virt-df), migrating between virtualization systems (see also:
@@ -6,22 +6,21 @@ virt-p2v), performing partial backups, performing partial guest
 clones, cloning guests and changing registry/UUID/hostname info, and
 much else besides.
 
-libguestfs uses Linux kernel and qemu code, and can access any type of
+Libguestfs uses Linux kernel and qemu code, and can access any type of
 guest filesystem that Linux and qemu can, including but not limited
 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
 schemes, qcow, qcow2, vmdk.
 
-libguestfs provides ways to enumerate guest storage (eg. partitions,
+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 mount guest filesystems on
-the host (requires root privs and NFS).
+in the context of the guest.  Also you can access filesystems over FTP.
 
-libguestfs is a library that can be linked with C and C++ management
+Libguestfs is a library that can be linked with C and C++ management
 programs (or management programs written in other languages, if people
 contribute the language bindings).  You can also use it from shell
 scripts or the command line.
 
-libguestfs was written by Richard W.M. Jones (rjones@redhat.com).
+Libguestfs was written by Richard W.M. Jones (rjones@redhat.com).
 For discussion please use the fedora-virt mailing list:
 
   https://www.redhat.com/mailman/listinfo/fedora-virt
@@ -36,6 +35,11 @@ Requirements
 
 - XDR, rpcgen
 
+- (Optional) perldoc to generate the manual pages
+
+- (Optional) OCaml if you want to modify the code or rebuild certain
+generated files.
+
 - (Optional) local Fedora mirror
 
 Running ./configure will check you have all the requirements installed
@@ -63,21 +67,44 @@ these commands as root:
 
   make install
 
+
 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
-operations and NFS export will work fine, but running commands in
+operations and FTP export 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.
+support in febootstrap, fakeroot and fakechroot.
 
 The daemon/ directory contains its own configure script.  This is so
 that in future we will be able to cross-compile the daemon.
 
 
+Mirroring tip
+----------------------------------------------------------------------
+
+Having a local Fedora mirror makes a massive difference to the time it
+takes to build and rebuild initramfs images.
+
+Failing that, use squid to cache yum downloads, but read this first:
+https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
+(In brief, because yum chooses random mirrors each time, squid doesn't
+work very well with default yum configuration.  To get around this,
+choose a Fedora mirror which is close to you, set this with
+'./configure --with-mirror=[...]', and then proxy the whole lot
+through squid by setting http_proxy environment variable).
+
+You will also need to substantially increase the squid configuration
+limits:
+http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
+
+IntelligentMirror is another possibility, although I couldn't get it
+to work for me.
+
+
 Copyright and license information
 ----------------------------------------------------------------------