diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2011-05-01 17:41:20 -0400 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2011-05-01 17:43:18 -0400 |
commit | c49fc3831d12788c27b90d12f06a1cd69a88e3be (patch) | |
tree | f72bee22981ea6bebd4da9c9fbaede7a090e0fb5 /tools | |
parent | 988a8784647a66adbece3c9fb470c06a4cce3cdd (diff) | |
download | libguestfs-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')
-rwxr-xr-x | tools/virt-edit | 2 | ||||
-rwxr-xr-x | tools/virt-make-fs | 16 | ||||
-rwxr-xr-x | tools/virt-tar | 16 | ||||
-rwxr-xr-x | tools/virt-win-reg | 14 |
4 files changed, 24 insertions, 24 deletions
diff --git a/tools/virt-edit b/tools/virt-edit index c1556eb9..a0042917 100755 --- a/tools/virt-edit +++ b/tools/virt-edit @@ -292,7 +292,7 @@ The first method is to temporarily set C<$EDITOR> to any script or program you want to run. The script is invoked as C<$EDITOR tmpfile> and it should update C<tmpfile> in place however it likes. -The second method is to use the C<-e> parameter of C<virt-edit> to run +The second method is to use the I<-e> parameter of C<virt-edit> to run a short Perl snippet in the style of L<sed(1)>. For example to replace all instances of C<foo> with C<bar> in a file: diff --git a/tools/virt-make-fs b/tools/virt-make-fs index 833c8a51..1a19b983 100755 --- a/tools/virt-make-fs +++ b/tools/virt-make-fs @@ -71,14 +71,14 @@ fit" the files that it contains, but might have extra space. Depending on how you are going to use the output, you might think this extra space is wasted and want to minimize it, or you might want to leave space so that more files can be added later. Virt-make-fs -defaults to minimizing the extra space, but you can use the C<--size> +defaults to minimizing the extra space, but you can use the I<--size> flag to leave space in the filesystem if you want it. An alternative way to leave extra space but not make the output image any bigger is to use an alternative disk image format (instead of the -default "raw" format). Using C<--format=qcow2> will use the native +default "raw" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 image format (check your hypervisor supports this -before using it). This allows you to choose a large C<--size> but the +before using it). This allows you to choose a large I<--size> but the extra space won't actually be allocated in the image until you try to store something in it. @@ -190,7 +190,7 @@ my $size; =item B<-s +E<lt>NE<gt>> -Use the C<--size> (or C<-s>) option to choose the size of the output +Use the I<--size> (or I<-s>) option to choose the size of the output image. If this option is I<not> given, then the output image will be just @@ -203,7 +203,7 @@ enough to contain all the input files, else you will get an error. To leave extra space, specify C<+> (plus sign) and a number followed by b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, -Terabytes, Petabytes or Exabytes. For example: C<--size=+200M> means +Terabytes, Petabytes or Exabytes. For example: I<--size=+200M> means enough space for the input files, and (approximately) an extra 200 MB free space. @@ -253,17 +253,17 @@ my $partition; If specified, this flag adds an MBR partition table to the output disk image. -You can change the partition table type, eg. C<--partition=gpt> for +You can change the partition table type, eg. I<--partition=gpt> for large disks. -Note that if you just use a lonesome C<--partition>, the Perl option +Note that if you just use a lonesome I<--partition>, the Perl option parser might consider the next parameter to be the partition type. For example: virt-make-fs --partition input.tar ... would cause virt-make-fs to think you wanted to use a partition type -of C<input.tar> which is completely wrong. To avoid this, use C<--> +of C<input.tar> which is completely wrong. To avoid this, use I<--> (a double dash) between options and the input file argument: virt-make-fs --partition -- input.tar ... 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. diff --git a/tools/virt-win-reg b/tools/virt-win-reg index 2db26712..695e619b 100755 --- a/tools/virt-win-reg +++ b/tools/virt-win-reg @@ -50,14 +50,14 @@ virt-win-reg - Export and merge Windows Registry entries from a Windows guest =head1 WARNING -You must I<not> use C<virt-win-reg> with the C<--merge> option on live +You must I<not> use C<virt-win-reg> with the I<--merge> option on live virtual machines. If you do this, you I<will> get irreversible disk corruption in the VM. C<virt-win-reg> tries to stop you from doing this, but doesn't catch all cases. Modifying the Windows Registry is an inherently risky operation. The format is deliberately obscure and undocumented, and Registry changes -can leave the system unbootable. Therefore when using the C<--merge> +can leave the system unbootable. Therefore when using the I<--merge> option, make sure you have a reliable backup first. =head1 DESCRIPTION @@ -68,7 +68,7 @@ Windows guest. The first parameter is the libvirt guest name or the raw disk image of a Windows guest. -If C<--merge> is I<not> specified, then the chosen registry +If I<--merge> is I<not> specified, then the chosen registry key is displayed/exported (recursively). For example: $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft' @@ -80,7 +80,7 @@ for example: $ virt-win-reg Windows7 $cvkey ProductName Windows 7 Enterprise -With C<--merge>, you can merge a textual regedit file into +With I<--merge>, you can merge a textual regedit file into the Windows Registry: $ virt-win-reg --merge Windows7 changes.reg @@ -160,7 +160,7 @@ In merge mode, this merges a textual regedit file into the Windows Registry of the virtual machine. If this flag is I<not> given then virt-win-reg displays or exports Registry entries instead. -Note that C<--merge> is I<unsafe> to use on live virtual machines, and +Note that I<--merge> is I<unsafe> to use on live virtual machines, and will result in disk corruption. However exporting (without this flag) is always safe. @@ -423,7 +423,7 @@ UTF-16LE with Windows-style line endings, you may need to reencode the whole file before or after processing. To reencode a file from Windows format to Linux (before processing it -with the C<--merge> option), you would do something like this: +with the I<--merge> option), you would do something like this: iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg @@ -442,7 +442,7 @@ file with Windows-style (CRLF) line endings, like this: software.reg: Little-endian UTF-16 Unicode text, with very long lines, with CRLF line terminators -This file would need conversion before you could C<--merge> it. +This file would need conversion before you could I<--merge> it. =head1 CurrentControlSet etc. |