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