X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=README;h=3960b613eadfb30a192bbecfa6312cca6101e8b4;hp=8bb69258a1b127a362b7eb30da228c5219fdf16d;hb=5790f5bfafb12cc2ed9365461bf66e0fdfde7150;hpb=84fbe21855b5b304413075fecb444135397591e6

diff --git a/README b/README
index 8bb6925..3960b61 100644
--- a/README
+++ b/README
@@ -15,7 +15,7 @@ Requirements
 - recent QEMU >= 0.13 with virtio-serial support
 
 - kernel >= 2.6.34 with virtio-serial support enabled.  virtio-block
-  and virtio-serial support are not required but highly recommended.
+  support is not required but comes highly recommended.
 
 - febootstrap >= 3.0 (recommended >= 3.3)
      *NB*: febootstrap 2.x WILL NOT WORK
@@ -32,13 +32,15 @@ Requirements
 
 - libxml2 (optional)
 
+- libconfig (optional, to parse /etc/libguestfs-tools.conf)
+
 - Augeas (http://augeas.net/) (optional)
 
 - gperf
 
 - squashfs-tools (mksquashfs only)
 
-- genisoimage / mkisofs
+- genisoimage (NOT mkisofs any more)
 
 - hivex >= 1.2.1 (http://libguestfs.org/download)
 
@@ -57,6 +59,8 @@ Requirements
 - (Optional) OCaml if you want to rebuild the generated files, and
   also to build the OCaml bindings
 
+- (Optional) OCaml PCRE bindings (ocaml-pcre).
+
 - (Optional) Perl if you want to build the perl bindings
 
 - (Optional) Python if you want to build the python bindings
@@ -80,10 +84,14 @@ bindings
 
 - (Optional, but highly recommended) perl-libintl for translating perl code.
 
-- (Optional) po4a for translating manpages and POD files.
+- po4a for translating manpages and POD files.
+  This is optional when compiling from the tarball, but mandatory
+  if you compile from git.
 
 - (Optional) PHP, phpize if you want to build the PHP bindings
 
+- (Optional, but highly recommended) getfacl, getfattr
+
 Running ./configure will check you have all the requirements installed
 on your machine.
 
@@ -105,6 +113,34 @@ this command as root:
 
   make install
 
+You can run the virt tools without needing to install, using the "run"
+script in the top directory.  This script sets up some environment
+variables.  For example:
+
+  ./run ./inspector/virt-inspector [usual virt-inspector args ...]
+
+If you are already in the inspector/ subdirectory, then the following
+command will also work:
+
+  ../run ./virt-inspector [...]
+
+You can also make a symlink (note: NOT a hard link) from your $PATH to
+the run script, eg:
+
+  cd ~/bin
+  ln -s ~/libguestfs/run libguestfs-run
+  cd ~/libguestfs
+  libguestfs-run ./inspector/virt-inspector [...]
+
+You can also run the C programs under valgrind like this:
+
+  ./run valgrind [valgrind opts...] ./cat/virt-cat [virt-cat opts...]
+
+This also works with sudo (eg. if you need root access for libvirt or
+to access a block device):
+
+  sudo ./run ./cat/virt-cat -d LinuxGuest /etc/passwd
+
 
 qemu
 ----------------------------------------------------------------------
@@ -208,7 +244,7 @@ appliance.  You will need to port the febootstrap first
 Copyright and license information
 ----------------------------------------------------------------------
 
-Copyright (C) 2009-2010 Red Hat Inc.
+Copyright (C) 2009-2011 Red Hat Inc.
 
 The library is distributed under the LGPLv2+.  The programs are
 distributed under the GPLv2+.  Please see the files COPYING and