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