summaryrefslogtreecommitdiffstats
path: root/tools/virt-tar
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2011-05-01 17:41:20 -0400
committerRichard W.M. Jones <rjones@redhat.com>2011-05-01 17:43:18 -0400
commitc49fc3831d12788c27b90d12f06a1cd69a88e3be (patch)
treef72bee22981ea6bebd4da9c9fbaede7a090e0fb5 /tools/virt-tar
parent988a8784647a66adbece3c9fb470c06a4cce3cdd (diff)
downloadlibguestfs-c49fc3831d12788c27b90d12f06a1cd69a88e3be.tar.gz
libguestfs-c49fc3831d12788c27b90d12f06a1cd69a88e3be.tar.xz
libguestfs-c49fc3831d12788c27b90d12f06a1cd69a88e3be.zip
doc: Use I<-...> for cross-references to command line options.
This is now used consistently across all the documentation.
Diffstat (limited to 'tools/virt-tar')
-rwxr-xr-xtools/virt-tar16
1 files changed, 8 insertions, 8 deletions
diff --git a/tools/virt-tar b/tools/virt-tar
index b2c2e882..bce2986e 100755
--- a/tools/virt-tar
+++ b/tools/virt-tar
@@ -63,12 +63,12 @@ Upload a local tarball and unpack it inside C</tmp> in the VM:
=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
@@ -85,14 +85,14 @@ If you want to just view a single file, use L<virt-cat(1)>. If you
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.
@@ -157,10 +157,10 @@ my $mode;
=item B<-u> | B<--upload>
-Use C<-x> to extract (download) a directory from a virtual machine
+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.