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.
+
=head1 API OVERVIEW
This section provides a gentler overview of the libguestfs API. We
calls to C<guestfs_inspect_get_*> return this cached information, but
I<do not> re-read the disks. If you change the content of the guest
disks, you can redo inspection by calling L</guestfs_inspect_os>
-again.
+again. (L</guestfs_inspect_list_applications> 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
=item B<OCaml>
-For documentation see the file C<guestfs.mli>.
+For documentation see L<guestfs-ocaml(3)>.
=item B<Perl>
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</etc/sysconfig/network> 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
=head1 SEE ALSO
+L<guestfs-examples(3)>,
+L<guestfs-ocaml(3)>,
L<guestfish(1)>,
L<guestmount(1)>,
L<virt-cat(1)>,
L<virt-df(1)>,
L<virt-edit(1)>,
+L<virt-filesystems(1)>,
L<virt-inspector(1)>,
L<virt-list-filesystems(1)>,
L<virt-list-partitions(1)>,