cat/virt-cat.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 virt-cat - Display files in a virtual machine
   6
   7 =head1 SYNOPSIS
   8
   9  virt-cat [--options] -d domname file [file ...]
  10
  11  virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]
  12
  13 Old-style:
  14
  15  virt-cat domname file
  16
  17  virt-cat disk.img file
  18
  19 =head1 DESCRIPTION
  20
  21 C<virt-cat> is a command line tool to display the contents of C<file>
  22 where C<file> exists in the named virtual machine (or disk image).
  23
  24 Multiple filenames can be given, in which case they are concatenated
  25 together.  Each filename must be a full path, starting at the root
  26 directory (starting with '/').
  27
  28 C<virt-cat> can be used to quickly view a file.  To edit a file, use
  29 C<virt-edit>.  For more complex cases you should look at the
  30 L<guestfish(1)> tool (see L</USING GUESTFISH> below).
  31
  32 =head1 EXAMPLES
  33
  34 Display C</etc/fstab> file from inside the libvirt VM called
  35 C<mydomain>:
  36
  37  virt-cat -d mydomain /etc/fstab
  38
  39 List syslog messages from a VM disk image file:
  40
  41  virt-cat -a disk.img /var/log/messages | tail
  42
  43 Find out what DHCP IP address a VM acquired:
  44
  45  virt-cat -d mydomain /var/log/messages | \
  46    grep 'dhclient: bound to' | tail
  47
  48 Find out what packages were recently installed:
  49
  50  virt-cat -d mydomain /var/log/yum.log | tail
  51
  52 Find out who is logged on inside a virtual machine:
  53
  54  virt-cat -d mydomain /var/run/utmp > /tmp/utmp
  55  who /tmp/utmp
  56
  57 or who was logged on:
  58
  59  virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp
  60  last -f /tmp/wtmp
  61
  62 =head1 OPTIONS
  63
  64 =over 4
  65
  66 =item B<--help>
  67
  68 Display brief help.
  69
  70 =item B<-a> file
  71
  72 =item B<--add> file
  73
  74 Add I<file> which should be a disk image from a virtual machine.  If
  75 the virtual machine has multiple block devices, you must supply all of
  76 them with separate I<-a> options.
  77
  78 The format of the disk image is auto-detected.  To override this and
  79 force a particular format use the I<--format=..> option.
  80
  81 =item B<-c> URI
  82
  83 =item B<--connect> URI
  84
  85 If using libvirt, connect to the given I<URI>.  If omitted, then we
  86 connect to the default libvirt hypervisor.
  87
  88 If you specify guest block devices directly (I<-a>), then libvirt is
  89 not used at all.
  90
  91 =item B<-d> guest
  92
  93 =item B<--domain> guest
  94
  95 Add all the disks from the named libvirt guest.  Domain UUIDs can be
  96 used instead of names.
  97
  98 =item B<--echo-keys>
  99
 100 When prompting for keys and passphrases, virt-cat normally turns
 101 echoing off so you cannot see what you are typing.  If you are not
 102 worried about Tempest attacks and there is no one else in the room you
 103 can specify this flag to see what you are typing.
 104
 105 =item B<--format=raw|qcow2|..>
 106
 107 =item B<--format>
 108
 109 The default for the I<-a> option is to auto-detect the format of the
 110 disk image.  Using this forces the disk format for I<-a> options which
 111 follow on the command line.  Using I<--format> with no argument
 112 switches back to auto-detection for subsequent I<-a> options.
 113
 114 For example:
 115
 116  virt-cat --format=raw -a disk.img file
 117
 118 forces raw format (no auto-detection) for C<disk.img>.
 119
 120  virt-cat --format=raw -a disk.img --format -a another.img file
 121
 122 forces raw format (no auto-detection) for C<disk.img> and reverts to
 123 auto-detection for C<another.img>.
 124
 125 If you have untrusted raw-format guest disk images, you should use
 126 this option to specify the disk format.  This avoids a possible
 127 security problem with malicious guests (CVE-2010-3851).
 128
 129 =item B<--keys-from-stdin>
 130
 131 Read key or passphrase parameters from stdin.  The default is
 132 to try to read passphrases from the user by opening C</dev/tty>.
 133
 134 =item B<-v>
 135
 136 =item B<--verbose>
 137
 138 Enable verbose messages for debugging.
 139
 140 =item B<-V>
 141
 142 =item B<--version>
 143
 144 Display version number and exit.
 145
 146 =item B<-x>
 147
 148 Enable tracing of libguestfs API calls.
 149
 150 =back
 151
 152 =head1 OLD-STYLE COMMAND LINE ARGUMENTS
 153
 154 Previous versions of virt-cat allowed you to write either:
 155
 156  virt-cat disk.img [disk.img ...] file
 157
 158 or
 159
 160  virt-cat guestname file
 161
 162 whereas in this version you should use I<-a> or I<-d> respectively
 163 to avoid the confusing case where a disk image might have the same
 164 name as a guest.
 165
 166 For compatibility the old style is still supported.
 167
 168 =head1 USING GUESTFISH
 169
 170 L<guestfish(1)> is a more powerful, lower level tool which you can use
 171 when C<virt-cat> doesn't work.
 172
 173 Using C<virt-cat> is approximately equivalent to doing:
 174
 175  guestfish --ro -i -d domname download file -
 176
 177 where C<domname> is the name of the libvirt guest, and C<file> is the
 178 full path to the file.  Note the final C<-> (meaning "output to
 179 stdout").
 180
 181 The command above uses libguestfs's guest inspection feature and so
 182 does not work on guests that libguestfs cannot inspect, or on things
 183 like arbitrary disk images that don't contain guests.  To display a
 184 file from a disk image directly, use:
 185
 186  guestfish --ro -a disk.img -m /dev/sda1 download file -
 187
 188 where C<disk.img> is the disk image, C</dev/sda1> is the filesystem
 189 within the disk image, and C<file> is the full path to the file.
 190
 191 =head1 SHELL QUOTING
 192
 193 Libvirt guest names can contain arbitrary characters, some of which
 194 have meaning to the shell such as C<#> and space.  You may need to
 195 quote or escape these characters on the command line.  See the shell
 196 manual page L<sh(1)> for details.
 197
 198 =head1 EXIT STATUS
 199
 200 This program returns 0 if successful, or non-zero if there was an
 201 error.
 202
 203 =head1 SEE ALSO
 204
 205 L<guestfs(3)>,
 206 L<guestfish(1)>,
 207 L<virt-copy-out(1)>,
 208 L<virt-edit(1)>,
 209 L<virt-tar-out(1)>,
 210 L<http://libguestfs.org/>.
 211
 212 =head1 AUTHOR
 213
 214 Richard W.M. Jones L<http://people.redhat.com/~rjones/>
 215
 216 =head1 COPYRIGHT
 217
 218 Copyright (C) 2010-2011 Red Hat Inc.
 219
 220 This program is free software; you can redistribute it and/or modify
 221 it under the terms of the GNU General Public License as published by
 222 the Free Software Foundation; either version 2 of the License, or
 223 (at your option) any later version.
 224
 225 This program is distributed in the hope that it will be useful,
 226 but WITHOUT ANY WARRANTY; without even the implied warranty of
 227 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 228 GNU General Public License for more details.
 229
 230 You should have received a copy of the GNU General Public License
 231 along with this program; if not, write to the Free Software
 232 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.