X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=src%2Fguestfs.pod;h=677d94498ac7369fb470486176f7cc14e063e83e;hb=b034795a259fb5f255c1f9c835d722efab4d4f7c;hp=b50f608959960561b2b3e2b3b09ba726e6d790e3;hpb=cd96cca38cea638a6db76afceeed76babc9e763c;p=libguestfs.git diff --git a/src/guestfs.pod b/src/guestfs.pod index b50f608..677d944 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -52,6 +52,9 @@ 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 section next. +There are also some example programs in the L +manual page. + =head1 API OVERVIEW This section provides a gentler overview of the libguestfs API. We @@ -576,7 +579,9 @@ inspection and caches the results in the guest handle. Subsequent calls to C return this cached information, but I re-read the disks. If you change the content of the guest disks, you can redo inspection by calling L -again. +again. (L works a little +differently from the other calls and does read the disks. See +documentation for that function for details). =head2 SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS @@ -652,7 +657,7 @@ with libguestfs. =item B -For documentation see the file C. +For documentation see L. =item B @@ -667,16 +672,11 @@ The PHP binding only works correctly on 64 bit machines. =item B -For documentation do: - - $ python - >>> import guestfs - >>> help (guestfs) +For documentation see L. =item B -Use the Guestfs module. There is no Ruby-specific documentation, but -you can find examples written in Ruby in the libguestfs source. +For documentation see L. =item B @@ -1093,6 +1093,14 @@ data. Callers should be careful to escape these before printing them to a structured file (for example, use HTML escaping if creating a web page). +Guest configuration may be altered in unusual ways by the +administrator of the virtual machine, and may not reflect reality +(particularly for untrusted or actively malicious guests). For +example we parse the hostname from configuration files like +C that we find in the guest, but the guest +administrator can easily manipulate these files to provide the wrong +hostname. + The inspection API parses guest configuration using two external libraries: Augeas (Linux configuration) and hivex (Windows Registry). Both are designed to be robust in the face of malicious data, although @@ -2073,11 +2081,16 @@ enough. =head1 SEE ALSO +L, +L, +L, +L, L, L, L, L, L, +L, L, L, L,