#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use warnings;
use strict;
virt-tar [--options] disk.img [disk.img ...] -u tarball directory
+=head1 NOTE
+
+This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>,
+L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements.
+
=head1 EXAMPLES
Download C</home> from the VM into a local tarball:
=head1 WARNING
-You must I<not> use C<virt-tar> with the C<-u> option (upload) on live
+You must I<not> use C<virt-tar> with the I<-u> option (upload) on live
virtual machines. If you do this, you risk disk corruption in the VM.
C<virt-tar> tries to stop you from doing this, but doesn't catch all
cases.
-You can use C<-x> (extract) on live virtual machines, but you might
+You can use I<-x> (extract) on live virtual machines, but you might
get inconsistent results or errors if there is filesystem activity
inside the VM. If the live VM is synched and quiescent, then
C<virt-tar> will usually work, but the only way to guarantee
just want to edit a single file, use L<virt-edit(1)>. For more
complex cases you should look at the L<guestfish(1)> tool.
-There are two modes of operation: C<-x> (eXtract) downloads a
+There are two modes of operation: I<-x> (eXtract) downloads a
directory and its contents (recursively) from the virtual machine into
-a local tarball. C<-u> uploads from a local tarball, unpacking it
+a local tarball. I<-u> uploads from a local tarball, unpacking it
into a directory inside the virtual machine. You cannot use these two
options together.
-In addition, you may need to use the C<-z> (gZip) option to enable
-compression. When uploading, you have to specify C<-z> if the upload
+In addition, you may need to use the I<-z> (gZip) option to enable
+compression. When uploading, you have to specify I<-z> if the upload
file is compressed because virt-tar won't detect this on its own.
C<virt-tar> can only handle tar (optionally gzipped) format tarballs.
my $uri;
-=item B<--connect URI> | B<-c URI>
+=item B<-c URI>
+
+=item B<--connect URI>
If using libvirt, connect to the given I<URI>. If omitted, then we
connect to the default libvirt hypervisor.
my $mode;
-=item B<-x> | B<--extract> | B<--download>
+=item B<-x>
+
+=item B<--extract>
-=item B<-u> | B<--upload>
+=item B<--download>
-Use C<-x> to extract (download) a directory from a virtual machine
+=item B<-u>
+
+=item B<--upload>
+
+Use I<-x> to extract (download) a directory from a virtual machine
to a local tarball.
-Use C<-u> to upload and unpack from a local tarball into a virtual
+Use I<-u> to upload and unpack from a local tarball into a virtual
machine. Please read the L</WARNING> section above before using this
option.
my $gzip;
-=item B<-z> | B<--gzip>
+=item B<-z>
+
+=item B<--gzip>
Specify that the input or output tarball is gzip-compressed.
L<guestfish(1)>,
L<virt-cat(1)>,
L<virt-edit(1)>,
+L<virt-copy-in(1)>,
+L<virt-copy-out(1)>,
+L<virt-tar-in(1)>,
+L<virt-tar-out(1)>,
L<Sys::Guestfs(3)>,
L<Sys::Guestfs::Lib(3)>,
L<Sys::Virt(3)>,
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.