Version 1.11.17.
[libguestfs.git] / fish / virt-tar-in.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 virt-tar-in - Unpack a tarball into a virtual machine disk image.
6
7 =head1 SYNOPSIS
8
9  virt-tar-in -a disk.img data.tar /destination
10
11  virt-tar-in -d domain data.tar /destination
12
13  zcat data.tar.gz | virt-tar-in -d domain - /destination
14
15 =head1 WARNING
16
17 Using C<virt-tar-in> on live virtual machines can be dangerous,
18 potentially causing disk corruption.  The virtual machine must be shut
19 down before you use this command.
20
21 =head1 DESCRIPTION
22
23 C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine
24 disk image or named libvirt domain.
25
26 The first parameter is the tar file.  Use C<-> to read the tar file
27 from standard input.  The second parameter is the absolute target
28 directory to unpack into.
29
30 =head1 EXAMPLES
31
32 Upload a home directory to a guest:
33
34  virt-tar-in -d MyGuest homes.tar /home
35
36 =head1 JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH
37
38 This command is just a simple shell script wrapper around the
39 L<guestfish(1)> C<tar-in> command.  For anything more complex than a
40 trivial copy, you are probably better off using guestfish directly.
41
42 =head1 OPTIONS
43
44 Since the shell script just passes options straight to guestfish, read
45 L<guestfish(1)> to see the full list of options.
46
47 =head1 SEE ALSO
48
49 L<guestfish(1)>,
50 L<virt-cat(1)>,
51 L<virt-copy-in(1)>,
52 L<virt-copy-out(1)>,
53 L<virt-edit(1)>,
54 L<virt-make-fs(1)>,
55 L<virt-tar-out(1)>,
56 L<http://libguestfs.org/>.
57
58 =head1 AUTHORS
59
60 Richard W.M. Jones (C<rjones at redhat dot com>)
61
62 =head1 COPYRIGHT
63
64 Copyright (C) 2011 Red Hat Inc.
65 L<http://libguestfs.org/>
66
67 This program is free software; you can redistribute it and/or modify
68 it under the terms of the GNU General Public License as published by
69 the Free Software Foundation; either version 2 of the License, or
70 (at your option) any later version.
71
72 This program is distributed in the hope that it will be useful,
73 but WITHOUT ANY WARRANTY; without even the implied warranty of
74 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
75 GNU General Public License for more details.
76
77 You should have received a copy of the GNU General Public License
78 along with this program; if not, write to the Free Software
79 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.