X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=tools%2Fvirt-tar;h=39a12cb05dc27779a67b125e0ffc106db931a8d8;hb=1ecc6b149364f3b4b6ed1a4b043821c3b025be98;hp=b2c2e882a1257d00940cdc1ae0939f08c7702f96;hpb=b8f9a20b039b34ba41098d1360866b6f9f74463d;p=libguestfs.git diff --git a/tools/virt-tar b/tools/virt-tar index b2c2e88..39a12cb 100755 --- a/tools/virt-tar +++ b/tools/virt-tar @@ -14,7 +14,7 @@ # # 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; @@ -63,12 +63,12 @@ Upload a local tarball and unpack it inside C in the VM: =head1 WARNING -You must I use C with the C<-u> option (upload) on live +You must I use C with the I<-u> option (upload) on live virtual machines. If you do this, you risk disk corruption in the VM. C 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 will usually work, but the only way to guarantee @@ -85,14 +85,14 @@ If you want to just view a single file, use L. If you just want to edit a single file, use L. For more complex cases you should look at the L 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 can only handle tar (optionally gzipped) format tarballs. @@ -124,7 +124,9 @@ Display version number and exit. 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. If omitted, then we connect to the default libvirt hypervisor. @@ -153,14 +155,20 @@ ensure the format is always specified. my $mode; -=item B<-x> | B<--extract> | B<--download> +=item B<-x> + +=item B<--extract> + +=item B<--download> -=item B<-u> | B<--upload> +=item B<-u> -Use C<-x> to extract (download) a directory from a virtual machine +=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 section above before using this option. @@ -170,7 +178,9 @@ You must specify exactly one of these options. my $gzip; -=item B<-z> | B<--gzip> +=item B<-z> + +=item B<--gzip> Specify that the input or output tarball is gzip-compressed. @@ -318,4 +328,4 @@ GNU General Public License for more details. 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.