Remove *~ files when doing 'make clean'.
[libguestfs.git] / README
diff --git a/README b/README
index 0cf9c4f..ecb5362 100644 (file)
--- a/README
+++ b/README
@@ -13,8 +13,7 @@ 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 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
 programs (or management programs written in other languages, if people
 
 Libguestfs is a library that can be linked with C and C++ management
 programs (or management programs written in other languages, if people
@@ -36,13 +35,18 @@ Requirements
 
 - XDR, rpcgen
 
 
 - XDR, rpcgen
 
-- (Optional) perldoc to generate the manual pages
+- Augeas (http://augeas.net/)
+
+- perldoc (pod2man, pod2text) to generate the manual pages and
+other documentation.
 
 - (Optional) OCaml if you want to modify the code or rebuild certain
 
 - (Optional) OCaml if you want to modify the code or rebuild certain
-generated files.
+generated files, and also to build the OCaml bindings
 
 - (Optional) local Fedora mirror
 
 
 - (Optional) local Fedora mirror
 
+- (Optional) Perl if you want to build the perl 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.
 
@@ -74,7 +78,7 @@ 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 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
 guests may not be possible.
 
 To enable this requires work for cross-architecture and 32-on-64
@@ -98,6 +102,13 @@ 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).
 
 './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
 ----------------------------------------------------------------------
 
 Copyright and license information
 ----------------------------------------------------------------------