Sys::Guestfs::Lib: deprecate inspection functions (RHBZ#642930).

[libguestfs.git] / tools / virt-cat

diff --git a/tools/virt-cat b/tools/virt-cat
index e000e25..66806a1 100755 (executable)
--- a/tools/virt-cat
+++ b/tools/virt-cat
@@ -109,6 +109,23 @@ connect to the default libvirt hypervisor.
 If you specify guest block devices directly, then libvirt is not used
 at all.
 
 If you specify guest block devices directly, then libvirt is not used
 at all.
 

+=cut
+
+my $format;
+
+=item B<--format> raw
+
+Specify the format of disk images given on the command line.  If this
+is omitted then the format is autodetected from the content of the
+disk image.
+
+If disk images are requested from libvirt, then this program asks
+libvirt for this information.  In this case, the value of the format
+parameter is ignored.
+
+If working with untrusted raw-format guest disk images, you should
+ensure the format is always specified.
+

 =back
 
 =cut
 =back
 
 =cut


@@ -116,6 +133,7 @@ at all.
 GetOptions ("help|?" => \$help,
             "version" => \$version,
             "connect|c=s" => \$uri,
 GetOptions ("help|?" => \$help,
             "version" => \$version,
             "connect|c=s" => \$uri,

+            "format=s" => \$format,

     ) or pod2usage (2);
 pod2usage (1) if $help;
 if ($version) {
     ) or pod2usage (2);
 pod2usage (1) if $help;
 if ($version) {


@@ -132,9 +150,9 @@ my $filename = pop @ARGV;
 
 my $g;
 if ($uri) {
 
 my $g;
 if ($uri) {

-    $g = open_guest (\@ARGV, address => $uri);
+    $g = open_guest (\@ARGV, address => $uri, format => $format);

 } else {
 } else {

-    $g = open_guest (\@ARGV);
+    $g = open_guest (\@ARGV, format => $format);

 }
 
 $g->launch ();
 }
 
 $g->launch ();


@@ -160,6 +178,13 @@ mount_operating_system ($g, $os);
 # NB: https://bugzilla.redhat.com/show_bug.cgi?id=501888
 print $g->download($filename, "/dev/stdout");
 
 # NB: https://bugzilla.redhat.com/show_bug.cgi?id=501888
 print $g->download($filename, "/dev/stdout");
 

+=head1 SHELL QUOTING
+
+Libvirt guest names can contain arbitrary characters, some of which
+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<sh(1)> for details.
+

 =head1 SEE ALSO
 
 L<guestfs(3)>,
 =head1 SEE ALSO
 
 L<guestfs(3)>,