File 0040-docs-Refresh-README-file.patch of Package libguestfs
From 83b91cf856d9e667c01d7d442fb48adb9d7f6f57 Mon Sep 17 00:00:00 2001 From: Richard W.M. Jones <rjones@redhat.com> Date: Sun, 19 Dec 2010 21:52:46 +0000 Subject: [PATCH 40/72] docs: Refresh README file. (cherry picked from commit 84fbe21855b5b304413075fecb444135397591e6) --- README | 52 ++++++++++++---------------------------------------- 1 files changed, 12 insertions(+), 40 deletions(-) diff --git a/README b/README index 57021e9..05009b2 100644 --- a/README +++ b/README @@ -1,43 +1,21 @@ -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: -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 -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, -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 -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, 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 -hacked on by lots of other people. For discussion, development, -patches, etc. please use the mailing list: +Libguestfs is tools and a library for accessing and modifying guest +disk images. For more information see the home page: - http://www.redhat.com/mailman/listinfo/libguestfs + http://libguestfs.org/ +For discussion, development, patches, etc. please use the mailing +list: -Home page ----------------------------------------------------------------------- - - http://libguestfs.org/ + http://www.redhat.com/mailman/listinfo/libguestfs Requirements ---------------------------------------------------------------------- -- recent QEMU >= 0.12 with virtio-serial support +- 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. - febootstrap >= 2.10 @@ -80,8 +58,6 @@ Requirements - (Optional) OCaml if you want to rebuild the generated files, and also to build the OCaml bindings -- (Optional) local Fedora mirror - - (Optional) Perl if you want to build the perl bindings - (Optional) Python if you want to build the python bindings @@ -118,13 +94,9 @@ Building Then make the daemon, library and root filesystem: - ./configure [--with-mirror=URI] + ./configure make -Use the optional --with-mirror parameter to specify the URI of a local -Fedora mirror. See the discussion of the MIRROR parameter in the -febootstrap(8) manpage. - Finally run the tests: make check @@ -303,7 +275,7 @@ Mirroring tip ---------------------------------------------------------------------- On my machines I can usually rebuild the appliance in around 3 -minutes. If it takes much longer for you, use a local Fedora mirror +minutes. If it takes much longer for you, use a local distro mirror or squid. To use squid to cache yum downloads, read this first: -- 1.7.1
