images: Make a better phony Fedora image.

[libguestfs.git] / tools / virt-ls

diff --git a/tools/virt-ls b/tools/virt-ls
index a55f6c3..03733f7 100755 (executable)
--- a/tools/virt-ls
+++ b/tools/virt-ls
@@ -1,6 +1,6 @@
 #!/usr/bin/perl -w
 # virt-ls
-# Copyright (C) 2009 Red Hat Inc.
+# Copyright (C) 2009-2010 Red Hat Inc.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,13 +20,12 @@ use warnings;
 use strict;
 
 use Sys::Guestfs;
-use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path
-  inspect_all_partitions inspect_partition
-  inspect_operating_systems mount_operating_system);
+use Sys::Guestfs::Lib qw(open_guest);
 use Pod::Usage;
 use Getopt::Long;
-use Locale::TextDomain 'libguestfs';
 use File::Temp qw/tempdir/;
+use File::Basename;
+use Locale::TextDomain 'libguestfs';
 
 =encoding utf8
 
@@ -110,6 +109,23 @@ 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.
+
+=cut
+
 my $mode;
 
 =item B<-l> | B<--long>
@@ -123,8 +139,8 @@ C<virt-ls -l> produces a "long listing", which shows more detail (just
 like the plain C<ls -l> command).
 
 C<virt-ls -R> produces a recursive list of files starting at the named
-directory.  See the documentation for the C<guestfs_find> command
-L<guestfs(3)> for precise details.
+directory.  See the documentation for L<guestfs(3)/guestfs_find>
+for precise details.
 
 You cannot combine these options.
 
@@ -147,6 +163,7 @@ sub set_mode_R
 GetOptions ("help|?" => \$help,
             "version" => \$version,
             "connect|c=s" => \$uri,
+            "format=s" => \$format,
             "long|l" => \&set_mode_l,
             "recursive|R" => \&set_mode_R,
     ) or pod2usage (2);
@@ -165,30 +182,27 @@ my $directory = pop @ARGV;
 
 my $g;
 if ($uri) {
-    $g = open_guest (\@ARGV, address => $uri);
+    $g = open_guest (\@ARGV, address => $uri, format => $format);
 } else {
-    $g = open_guest (\@ARGV);
+    $g = open_guest (\@ARGV, format => $format);
 }
 
 $g->launch ();
 
-# List of possible filesystems.
-my @partitions = get_partitions ($g);
-
-# Now query each one to build up a picture of what's in it.
-my %fses =
-    inspect_all_partitions ($g, \@partitions,
-      use_windows_registry => 0);
-
-my $oses = inspect_operating_systems ($g, \%fses);
-
-my @roots = keys %$oses;
-die __"no root device found in this operating system image\n" if @roots == 0;
-die __"multiboot operating systems are not supported by virt-ls\n" if @roots > 1;
-my $root_dev = $roots[0];
-
-my $os = $oses->{$root_dev};
-mount_operating_system ($g, $os);
+my @roots = $g->inspect_os ();
+if (@roots == 0) {
+    die __x("{prog}: No operating system could be detected inside this disk image.\n\nThis may be because the file is not a disk image, or is not a virtual machine\nimage, or because the OS type is not understood by libguestfs.\n\nIf you feel this is an error, please file a bug report including as much\ninformation about the disk image as possible.\n",
+            prog => basename ($0));
+}
+if (@roots > 1) {
+    die __x("{prog}: multiboot operating systems are not supported.\n",
+            prog => basename ($0))
+}
+my %fses = $g->inspect_get_mountpoints ($roots[0]);
+my @fses = sort { length $a <=> length $b } keys %fses;
+foreach (@fses) {
+    $g->mount_ro ($fses{$_}, $_);
+}
 
 unless ($mode) {
     my @r = $g->ls ($directory);
@@ -202,12 +216,19 @@ unless ($mode) {
     my $r;
     my $line;
     while (($r = read (F, $line, 1024)) > 0) {
-       $line =~ tr{\0}{\n};
-       print $line;
+        $line =~ tr{\0}{\n};
+        print $line;
     }
     close F;
 }
 
+=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)>,
@@ -221,7 +242,7 @@ L<http://libguestfs.org/>.
 
 =head1 AUTHOR
 
-Richard W.M. Jones L<http://et.redhat.com/~rjones/>
+Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 
 =head1 COPYRIGHT