.\" Automatically generated by Podwrapper::Man 1.44.2 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "virt-tar 1"
.TH virt-tar 1 "2021-09-07" "libguestfs-1.44.2" "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
virt\-tar \- Extract or upload files to a virtual machine
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& virt\-tar [\-\-options] \-x domname directory tarball
\&
\& virt\-tar [\-\-options] \-u domname tarball directory
\&
\& virt\-tar [\-\-options] disk.img [disk.img ...] \-x directory tarball
\&
\& virt\-tar [\-\-options] disk.img [disk.img ...] \-u tarball directory
.Ve
.SH "OBSOLETE"
.IX Header "OBSOLETE"
This tool is obsolete.  Use \fBvirt\-copy\-in\fR\|(1), \fBvirt\-copy\-out\fR\|(1),
\&\fBvirt\-tar\-in\fR\|(1), \fBvirt\-tar\-out\fR\|(1) as replacements.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Download \f(CW\*(C`/home\*(C'\fR from the \s-1VM\s0 into a local tarball:
.PP
.Vb 1
\& virt\-tar \-x domname /home home.tar
\&
\& virt\-tar \-zx domname /home home.tar.gz
.Ve
.PP
Upload a local tarball and unpack it inside \f(CW\*(C`/tmp\*(C'\fR in the \s-1VM:\s0
.PP
.Vb 1
\& virt\-tar \-u domname uploadstuff.tar /tmp
\&
\& virt\-tar \-zu domname uploadstuff.tar.gz /tmp
.Ve
.SH "WARNING"
.IX Header "WARNING"
You must \fInot\fR use \f(CW\*(C`virt\-tar\*(C'\fR with the \fI\-u\fR option (upload) on live
virtual machines.  If you do this, you risk disk corruption in the \s-1VM.\s0
\&\f(CW\*(C`virt\-tar\*(C'\fR tries to stop you from doing this, but doesn't catch all
cases.
.PP
You can use \fI\-x\fR (extract) on live virtual machines, but you might
get inconsistent results or errors if there is filesystem activity
inside the \s-1VM.\s0  If the live \s-1VM\s0 is synched and quiescent, then
\&\f(CW\*(C`virt\-tar\*(C'\fR will usually work, but the only way to guarantee
consistent results is if the virtual machine is shut down.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`virt\-tar\*(C'\fR is a general purpose archive tool for downloading and
uploading parts of a guest filesystem.  There are many possibilities:
making backups, uploading data files, snooping on guest activity,
fixing or customizing guests, etc.
.PP
If you want to just view a single file, use \fBvirt\-cat\fR\|(1).  If you
just want to edit a single file, use \fBvirt\-edit\fR\|(1).  For more
complex cases you should look at the \fBguestfish\fR\|(1) tool.
.PP
There are two modes of operation: \fI\-x\fR (eXtract) downloads a
directory and its contents (recursively) from the virtual machine into
a local tarball.  \fI\-u\fR uploads from a local tarball, unpacking it
into a directory inside the virtual machine.  You cannot use these two
options together.
.PP
In addition, you may need to use the \fI\-z\fR (gZip) option to enable
compression.  When uploading, you have to specify \fI\-z\fR if the upload
file is compressed because virt-tar won't detect this on its own.
.PP
\&\f(CW\*(C`virt\-tar\*(C'\fR can only handle tar (optionally gzipped) format tarballs.
For example it cannot do PKZip files or bzip2 compression.  If you
want that then you'll have to rebuild the tarballs yourself.  (This is
a limitation of the \fBlibguestfs\fR\|(3) \s-1API\s0).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Display brief help.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Display version number and exit.
.IP "\fB\-c \s-1URI\s0\fR" 4
.IX Item "-c URI"
.PD 0
.IP "\fB\-\-connect \s-1URI\s0\fR" 4
.IX Item "--connect URI"
.PD
If using libvirt, connect to the given \fI\s-1URI\s0\fR.  If omitted, then we
connect to the default libvirt hypervisor.
.Sp
If you specify guest block devices directly, then libvirt is not used
at all.
.IP "\fB\-\-format\fR raw" 4
.IX Item "--format raw"
Specify the format of disk images given on the command line.  If this
is omitted then the format is autodetected from the content of the
disk image.
.Sp
If disk images are requested from libvirt, then this program asks
libvirt for this information.  In this case, the value of the format
parameter is ignored.
.Sp
If working with untrusted raw-format guest disk images, you should
ensure the format is always specified.
.IP "\fB\-x\fR" 4
.IX Item "-x"
.PD 0
.IP "\fB\-\-extract\fR" 4
.IX Item "--extract"
.IP "\fB\-\-download\fR" 4
.IX Item "--download"
.IP "\fB\-u\fR" 4
.IX Item "-u"
.IP "\fB\-\-upload\fR" 4
.IX Item "--upload"
.PD
Use \fI\-x\fR to extract (download) a directory from a virtual machine
to a local tarball.
.Sp
Use \fI\-u\fR to upload and unpack from a local tarball into a virtual
machine.  Please read the \*(L"\s-1WARNING\*(R"\s0 section above before using this
option.
.Sp
You must specify exactly one of these options.
.IP "\fB\-z\fR" 4
.IX Item "-z"
.PD 0
.IP "\fB\-\-gzip\fR" 4
.IX Item "--gzip"
.PD
Specify that the input or output tarball is gzip-compressed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBguestfs\fR\|(3),
\&\fBguestfish\fR\|(1),
\&\fBvirt\-cat\fR\|(1),
\&\fBvirt\-edit\fR\|(1),
\&\fBvirt\-copy\-in\fR\|(1),
\&\fBvirt\-copy\-out\fR\|(1),
\&\fBvirt\-tar\-in\fR\|(1),
\&\fBvirt\-tar\-out\fR\|(1),
\&\fBSys::Guestfs\fR\|(3),
\&\fBSys::Virt\fR\|(3),
http://libguestfs.org/.
.SH "AUTHOR"
.IX Header "AUTHOR"
Richard W.M. Jones http://people.redhat.com/~rjones/
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2009 Red Hat Inc.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, \s-1MA 02110\-1301 USA.\s0
.SH "BUGS"
.IX Header "BUGS"
To get a list of bugs against libguestfs, use this link:
https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
.PP
To report a new bug against libguestfs, use this link:
https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
.PP
When reporting a bug, please supply:
.IP "\(bu" 4
The version of libguestfs.
.IP "\(bu" 4
Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
.IP "\(bu" 4
Describe the bug accurately and give a way to reproduce it.
.IP "\(bu" 4
Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR
output into the bug report.