man pages: Add a standard EXIT STATUS section to most pages.

[libguestfs.git] / fuse / guestmount.pod

diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod
index 9fbefcf..fef84d9 100644 (file)
--- a/fuse/guestmount.pod
+++ b/fuse/guestmount.pod
@@ -70,29 +70,47 @@ If you want to debug the program, we recommend:
 
  guestmount [...] --trace --verbose /mnt
 
+=head1 NOTES
+
+=head2 Other users cannot see the filesystem by default
+
+If you mount a filesystem as one user (eg. root), then other users
+will not be able to see it by default.  The fix is to add the FUSE
+C<allow_other> option when mounting:
+
+ sudo guestmount [...] -o allow_other /mnt
+
 =head1 OPTIONS
 
 =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
 mode, only libvirt domains which are shut down can be named here.
 
+Domain UUIDs can be used instead of names.
+
 =item B<--dir-cache-timeout N>
 
 Set the readdir cache timeout to I<N> seconds, the default being 60
@@ -112,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
@@ -132,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
@@ -168,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.
 
@@ -210,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.
@@ -226,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.
 
@@ -264,6 +300,11 @@ See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>.
 
 =back
 
+=head1 EXIT STATUS
+
+This program returns 0 if successful, or non-zero if there was an
+error.
+
 =head1 SEE ALSO
 
 L<guestfish(1)>,