diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2012-05-01 11:18:57 +0100 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2012-05-01 14:51:56 +0100 |
commit | a2c94ab7cd1afeef8b44659411e4b9a9ac0a454a (patch) | |
tree | 78a82322a8bd5e1d49628a1c36730b507f42bdfa | |
parent | c5955af8e1b572b08818aef18fb60c6c8de5a182 (diff) | |
download | libguestfs-a2c94ab7cd1afeef8b44659411e4b9a9ac0a454a.tar.gz libguestfs-a2c94ab7cd1afeef8b44659411e4b9a9ac0a454a.tar.xz libguestfs-a2c94ab7cd1afeef8b44659411e4b9a9ac0a454a.zip |
doc: Rewrite description section in man page guestfs(3).
Make the introduction in the man page shorter and punchier, so it
leads readers directly to other pages of interest.
(cherry picked from commit 922052c70fdc66859c78bbc89a7817aad141862a)
-rw-r--r-- | src/guestfs.pod | 43 |
1 files changed, 12 insertions, 31 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index 249c5d07..95ff3409 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -22,37 +22,18 @@ or: =head1 DESCRIPTION -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, Erlang, Haskell or C#). You can also use it from shell -scripts or the command line. - -You don't need to be root to use libguestfs, although obviously you do -need enough permissions to access the disk images. - -Libguestfs is a large API because it can do many things. For a gentle -introduction, please read the L</API OVERVIEW> section next. - -There are also some example programs in the L<guestfs-examples(3)> -manual page. +Libguestfs is a library for accessing and modifying disk images and +virtual machines. This manual page documents the C API. + +If you are looking for an introduction to libguestfs, see the web +site: L<http://libguestfs.org/> + +Each virt tool has its own man page (for a full list, go to +L</SEE ALSO> at the end of this file). + +For examples of using the API from C, see L<guestfs-examples(3)>. For +examples in other languages, see +L</USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES> below. =head1 API OVERVIEW |