From 34d9fed24ad6a2d2e13bb817820e31373f6756e1 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sat, 16 Apr 2011 21:12:53 +0100 Subject: [PATCH] inspector: Refresh the virt-inspector(1) manpage. --- inspector/virt-inspector.pod | 60 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 4 deletions(-) diff --git a/inspector/virt-inspector.pod b/inspector/virt-inspector.pod index 26c6126..225e3f6 100755 --- a/inspector/virt-inspector.pod +++ b/inspector/virt-inspector.pod @@ -45,6 +45,13 @@ for-loop). Because virt-inspector needs direct access to guest images, it won't normally work over remote libvirt connections. +All of the information available from virt-inspector is also available +through the core libguestfs inspection API (see +L). The same information can also be fetched +using guestfish or via libguestfs bindings in many programming +languages +(see L). + =head1 OPTIONS =over 4 @@ -145,7 +152,8 @@ For compatibility the old style is still supported. =head1 XML FORMAT The virt-inspector XML is described precisely in a RELAX NG schema -which is supplied with libguestfs. This section is just an overview. +file C which is supplied with libguestfs. This +section is just an overview. The top-level element is EoperatingsystemsE, and it contains one or more EoperatingsystemE elements. You would only see @@ -171,8 +179,13 @@ describe the operating system, its architecture, the descriptive /Windows installed -These fields are derived from the libguestfs inspection API, and -you can find more details in L. +In brief, EnameE is the class of operating system (something +like C or C), EdistroE is the distribution +(eg. C but many other distros are recognized) and +EarchE is the guest architecture. The other fields are fairly +self-explanatory, but because these fields are taken directly from the +libguestfs inspection API you can find precise information from +L. The ErootE element is the root filesystem device, but from the point of view of libguestfs (block devices may have completely @@ -202,7 +215,8 @@ devices. EfilesystemsE is like EmountpointsE but covers I filesystems belonging to the guest, including swap and empty partitions. (In the rare case of a multi-boot guest, it covers -filesystems belonging to this OS or shared by this OS and other OSes). +filesystems belonging to this OS or shared with this OS and other +OSes). You might see something like this: @@ -248,6 +262,28 @@ The version and release fields may not be available for some types guests. Other fields are possible, see L. +=head2 Edrive_mappingsE + +For operating systems like Windows which use drive letters, +virt-inspector is able to find out how drive letters map to +filesystems. + + + + ... + + /dev/sda2 + /dev/sdb1 + + +In the example above, drive C maps to the filesystem on the second +partition on the first disk, and drive E maps to the filesystem on the +first partition on the second disk. + +Note that this only covers permanent local filesystem mappings, not +things like network shares. Furthermore NTFS volume mount points may +not be listed here. + =head2 INSPECTING INSTALL DISKS, LIVE CDs Virt-inspector can detect some operating system installers on @@ -295,6 +331,22 @@ have meaning to the shell such as C<#> and space. You may need to quote or escape these characters on the command line. See the shell manual page L for details. +=head1 OLD VERSIONS OF VIRT-INSPECTOR + +Early versions of libguestfs shipped with a different virt-inspector +program written in Perl (the current version is written in C). The +XML output of the Perl virt-inspector was different and it could also +output in other formats like text. + +The old virt-inspector is no longer supported or shipped with +libguestfs. + +To confuse matters further, in Red Hat Enterprise Linux 6 we ship two +versions of virt-inspector with different names: + + virt-inspector Old Perl version. + virt-inspector2 New C version. + =head1 SEE ALSO L, -- 1.8.3.1