summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2011-07-16 15:20:29 +0100
committerRichard W.M. Jones <rjones@redhat.com>2011-07-16 15:20:29 +0100
commita711777bedcf64d814bb953ff8771858dbd7161b (patch)
tree7c334f32f2b64e6a41d5a27f54c65bfc7d733474
parentd84bb5dc19afd30c44f984b1c33c92691aa236f7 (diff)
downloadlibguestfs-a711777bedcf64d814bb953ff8771858dbd7161b.tar.gz
libguestfs-a711777bedcf64d814bb953ff8771858dbd7161b.tar.xz
libguestfs-a711777bedcf64d814bb953ff8771858dbd7161b.zip
docs: Separate out combined =item 's in man pages.
Turn: =item B<-a> | B<--all> into: =item B<-a> =item B<--all> This gives a more natural-looking manual page, as well as making it easier to directly link to these sections.
-rwxr-xr-xcat/virt-ls.pod8
-rwxr-xr-xdf/virt-df.pod4
-rw-r--r--edit/virt-edit.pod4
-rw-r--r--fuse/guestmount.pod48
-rw-r--r--generator/generator_actions.ml12
-rwxr-xr-xtools/virt-list-filesystems12
-rwxr-xr-xtools/virt-list-partitions16
-rwxr-xr-xtools/virt-tar18
-rwxr-xr-xtools/virt-win-reg4
9 files changed, 95 insertions, 31 deletions
diff --git a/cat/virt-ls.pod b/cat/virt-ls.pod
index 78164b50..e63f009d 100755
--- a/cat/virt-ls.pod
+++ b/cat/virt-ls.pod
@@ -363,9 +363,13 @@ L</RECURSIVE LONG LISTING> above.
Read key or passphrase parameters from stdin. The default is
to try to read passphrases from the user by opening C</dev/tty>.
-=item B<-l> | B<--long>
+=item B<-l>
-=item B<-R> | B<--recursive>
+=item B<--long>
+
+=item B<-R>
+
+=item B<--recursive>
Select the mode. With neither of these options, C<virt-ls> produces a
simple, flat list of the files in the named directory. See
diff --git a/df/virt-df.pod b/df/virt-df.pod
index e9f416c5..65d78a17 100755
--- a/df/virt-df.pod
+++ b/df/virt-df.pod
@@ -124,7 +124,9 @@ Print sizes in human-readable format.
You are not allowed to use I<-h> and I<--csv> at the same time.
-=item B<--inodes> | B<-i>
+=item B<-i>
+
+=item B<--inodes>
Print inodes instead of blocks.
diff --git a/edit/virt-edit.pod b/edit/virt-edit.pod
index 96112040..ce7ed1df 100644
--- a/edit/virt-edit.pod
+++ b/edit/virt-edit.pod
@@ -92,7 +92,9 @@ so you would write:
By default, no backup file is made.
-=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.
diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod
index cada4cc6..fe759fb6 100644
--- a/fuse/guestmount.pod
+++ b/fuse/guestmount.pod
@@ -84,20 +84,26 @@ C<allow_other> option when mounting:
=over 4
-=item B<-a image> | B<--add image>
+=item B<-a image>
+
+=item B<--add image>
Add a block device or virtual machine image.
The format of the disk image is auto-detected. To override this and
force a particular format use the I<--format=..> option.
-=item B<-c URI> | B<--connect URI>
+=item B<-c URI>
+
+=item B<--connect URI>
When used in conjunction with the I<-d> option, this specifies
the libvirt URI to use. The default is to use the default libvirt
connection.
-=item B<-d libvirt-domain> | B<--domain libvirt-domain>
+=item B<-d libvirt-domain>
+
+=item B<--domain libvirt-domain>
Add disks from the named libvirt domain. If the I<--ro> option is
also used, then any libvirt domain can be used. However in write
@@ -124,7 +130,9 @@ echoing off so you cannot see what you are typing. If you are not
worried about Tempest attacks and there is no one else in the room
you can specify this flag to see what you are typing.
-=item B<--format=raw|qcow2|..> | B<--format>
+=item B<--format=raw|qcow2|..>
+
+=item B<--format>
The default for the I<-a> option is to auto-detect the format of the
disk image. Using this forces the disk format for I<-a> options which
@@ -144,7 +152,9 @@ Display help on special FUSE options (see I<-o> below).
Display brief help and exit.
-=item B<-i> | B<--inspector>
+=item B<-i>
+
+=item B<--inspector>
Using L<virt-inspector(1)> code, inspect the disks looking for
an operating system and mount filesystems as they would be
@@ -180,14 +190,18 @@ filesystem can support them:
-m /dev/sda1:/:acl,user_xattr
-=item B<-n> | B<--no-sync>
+=item B<-n>
+
+=item B<--no-sync>
By default, we attempt to sync the guest disk when the FUSE mountpoint
is unmounted. If you specify this option, then we don't attempt to
sync the disk. See the discussion of autosync in the L<guestfs(3)>
manpage.
-=item B<-o option> | B<--option option>
+=item B<-o option>
+
+=item B<--option option>
Pass extra options to FUSE.
@@ -222,7 +236,9 @@ to the chosen values.
=back
-=item B<-r> | B<--ro>
+=item B<-r>
+
+=item B<--ro>
Add devices and mount everything read-only. Also disallow writes and
make the disk appear read-only to FUSE.
@@ -238,22 +254,30 @@ See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
Enable SELinux support for the guest.
-=item B<-v> | B<--verbose>
+=item B<-v>
+
+=item B<--verbose>
Enable verbose messages from underlying libguestfs.
-=item B<-V> | B<--version>
+=item B<-V>
+
+=item B<--version>
Display the program version and exit.
-=item B<-w> | B<--rw>
+=item B<-w>
+
+=item B<--rw>
This changes the I<-a>, I<-d> and I<-m> options so that disks are
added and mounts are done read-write.
See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
-=item B<-x> | B<--trace>
+=item B<-x>
+
+=item B<--trace>
Trace libguestfs calls and entry into each FUSE function.
diff --git a/generator/generator_actions.ml b/generator/generator_actions.ml
index 87c934aa..56976dda 100644
--- a/generator/generator_actions.ml
+++ b/generator/generator_actions.ml
@@ -4843,7 +4843,9 @@ Possible values for C<parttype> are:
=over 4
-=item B<efi> | B<gpt>
+=item B<efi>
+
+=item B<gpt>
Intel EFI / GPT partition table.
@@ -4851,7 +4853,9 @@ This is recommended for >= 2 TB partitions that will be accessed
from Linux and Intel-based Mac OS X. It also has limited backwards
compatibility with the C<mbr> format.
-=item B<mbr> | B<msdos>
+=item B<mbr>
+
+=item B<msdos>
The standard PC \"Master Boot Record\" (MBR) format used
by MS-DOS and Windows. This partition type will B<only> work
@@ -4869,7 +4873,9 @@ supported include:
AIX disk labels.
-=item B<amiga> | B<rdb>
+=item B<amiga>
+
+=item B<rdb>
Amiga \"Rigid Disk Block\" format.
diff --git a/tools/virt-list-filesystems b/tools/virt-list-filesystems
index 6b818b0e..50f95f25 100755
--- a/tools/virt-list-filesystems
+++ b/tools/virt-list-filesystems
@@ -74,7 +74,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<URI>. If omitted, then we
connect to the default libvirt hypervisor.
@@ -103,7 +105,9 @@ ensure the format is always specified.
my $long;
-=item B<-l> | B<--long>
+=item B<-l>
+
+=item B<--long>
With this option, C<virt-list-filesystems> displays the type of
each filesystem too (where "type" means C<ext3>, C<xfs> etc.)
@@ -112,7 +116,9 @@ each filesystem too (where "type" means C<ext3>, C<xfs> etc.)
my $all;
-=item B<-a> | B<--all>
+=item B<-a>
+
+=item B<--all>
Normally we only show mountable filesystems. If this option
is given then swap devices are shown too.
diff --git a/tools/virt-list-partitions b/tools/virt-list-partitions
index 0baa2921..496116f8 100755
--- a/tools/virt-list-partitions
+++ b/tools/virt-list-partitions
@@ -75,7 +75,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<URI>. If omitted, then we
connect to the default libvirt hypervisor.
@@ -104,7 +106,9 @@ ensure the format is always specified.
my $human;
-=item B<-h> | B<--human-readable>
+=item B<-h>
+
+=item B<--human-readable>
Show sizes in human-readable form (eg. "1G").
@@ -112,7 +116,9 @@ Show sizes in human-readable form (eg. "1G").
my $long;
-=item B<-l> | B<--long>
+=item B<-l>
+
+=item B<--long>
With this option, C<virt-list-partitions> displays the type
and size of each partition too (where "type" means C<ext3>, C<pv> etc.)
@@ -121,7 +127,9 @@ and size of each partition too (where "type" means C<ext3>, C<pv> etc.)
my $total;
-=item B<-t> | B<--total>
+=item B<-t>
+
+=item B<--total>
Display the total size of each block device (as a separate row or
rows).
diff --git a/tools/virt-tar b/tools/virt-tar
index bce2986e..6b7fcd88 100755
--- a/tools/virt-tar
+++ b/tools/virt-tar
@@ -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<URI>. If omitted, then we
connect to the default libvirt hypervisor.
@@ -153,9 +155,15 @@ 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>
+
+=item B<--upload>
Use I<-x> to extract (download) a directory from a virtual machine
to a local tarball.
@@ -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.
diff --git a/tools/virt-win-reg b/tools/virt-win-reg
index 17c42a16..c9597e7f 100755
--- a/tools/virt-win-reg
+++ b/tools/virt-win-reg
@@ -125,7 +125,9 @@ Enable debugging messages.
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.